DX STF Client API

GetTransactionalPartyById

Transactional Party Requests

Transactional Party

The following routes are available for this service:
GET	/api/transactionalParty/{Id}	Get specific transactionalParty by transactionalParty Id

**GetTransactionalPartyById** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	Guid	No	transactionalParty ID or Token

**TransactionalPartyMessage** Parameters:
Name	Parameter	Data Type	Required	Description
Header	form	Header	Yes
TransactionalParty	form	TransactionalPartyMessageType	Yes

**Header** Parameters:
Name	Parameter	Data Type	Required
DocumentIdentification	form	DocumentIdentification	Yes
Sender	form	Partner	Yes
Receiver	form	Partner	Yes

**DocumentIdentification** Parameters:
Name	Parameter	Data Type	Required
Identifier	form	string	Yes
Type	form	string	Yes
CreationDateAndTime	form	DateTime	No

**Partner** Parameters:
Name	Parameter	Data Type	Required	Description
Identifier	form	Identifier	Yes
ContactInformation	form	List<ContactInformation>	Yes

**Identifier** Parameters:
Name	Parameter	Data Type	Required	Description
Authority	form	string	Yes
Text	form	string	Yes

**TransactionalPartyMessageType** Parameters:
Name	Parameter	Data Type	Required
CreationDateTime	form	DateTime	No
LastUpdateDateTime	form	DateTime?	No
DocumentActionCode	form	DocumentAction	No
DocumentStatusCode	form	DocumentStatus	No
DocumentStructureVersion	form	string	Yes
RevisionNumber	form	long?	No
AvpList	form	List<AvpList>	Yes

**TransactionalParty** Parameters:
Name	Parameter	Data Type	Required
Contact	form	List<Contact>	Yes
Address	form	Address	Yes
CommunicationChannel	form	List<AvpList>	Yes
FinancialInstitutionInformation	form	FinancialInstitutionInformation	Yes
DutyFeeTaxRegistration	form	string	Yes
EntityIdentification	form	string	Yes

**Ecom_PartyIdentificationType** Parameters:
Name	Parameter	Data Type	Required
Gln	form	string	Yes
Name	form	string	Yes
AdditionalPartyIdentification	form	List<AvpList>	Yes

**AvpList** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	Yes
Value	form	string	Yes

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactTypeCode	form	string	Yes
PersonName	form	string	Yes
DepartmentName	form	string	Yes
JobTitle	form	string	Yes
Responsibility	form	string	Yes
CommunicationChannel	form	List<CommunicationChannel>	Yes

**CommunicationChannel** Parameters:
Name	Parameter	Data Type	Required
CommunicationChannelCode	form	string	Yes
CommunicationChannelName	form	string	Yes
CommunicationValue	form	string	Yes

**Address** Parameters:
Name	Parameter	Data Type	Required
StreetAddressOne	form	string	Yes
StreetAddressTwo	form	string	Yes
StreetAddressThree	form	string	Yes
City	form	string	Yes
PostalCode	form	string	Yes
ProvinceCode	form	string	Yes
CountryCode	form	string	Yes

**FinancialInstitutionInformation** Parameters:
Name	Parameter	Data Type	Required
FinancialInstitutionBranchName	form	string	Yes
FinancialInstitutionName	form	string	Yes
FinancialRoutingNumber	form	FinancialRoutingNumber	Yes
FinancialAccount	form	FinancialAccount	Yes
SwiftCode	form	string	Yes
ExportersCode	form	string	Yes

**FinancialRoutingNumber** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	Yes
NumberTypeCode	form	string	Yes

**FinancialAccount** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	Yes
NumberTypeCode	form	string	Yes
Name	form	string	Yes

**DocumentAction** Enum:
ADD
CHANGE_BY_REFRESH
DELETE
REJECTED

**DocumentStatus** Enum:
ADDITIONAL_TRANSMISSION
COPY
ORIGINAL

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/transactionalParty/{Id} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"header":{"documentIdentification":{"identifier":"String","type":"String"},"sender":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]},"receiver":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]}},"transactionalParty":{"lastUpdateDateTime":"0001-01-01","documentActionCode":"ADD","documentStatusCode":"ADDITIONAL_TRANSMISSION","documentStructureVersion":"String","revisionNumber":0,"avpList":[{"code":"String","value":"String"}],"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]}}