DX STF Client API

<back to all web services

GetTransactionalPartyByParam

Transactional Party Requests

Transactional Party

Requires Authentication
The following routes are available for this service:
GET/api/transactionalPartyGet transactional party by params

// @DataContract
export class DocumentIdentification
{
    // @DataMember(Name="identifier")
    public identifier: string;

    // @DataMember(Name="type")
    public type: string;

    // @DataMember(Name="creationDateAndTime")
    public creationDateAndTime: string;

    public constructor(init?: Partial<DocumentIdentification>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Identifier
{
    // @DataMember(Name="authority")
    public authority: string;

    // @DataMember(Name="text")
    public text: string;

    public constructor(init?: Partial<Identifier>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ContactInformation
{

    public constructor(init?: Partial<ContactInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Partner
{
    // @DataMember(Name="identifier")
    public identifier: Identifier;

    // @DataMember(Name="contactInformation")
    public contactInformation: ContactInformation[] = [];

    public constructor(init?: Partial<Partner>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Header
{
    // @DataMember(Name="documentIdentification")
    public documentIdentification: DocumentIdentification;

    // @DataMember(Name="sender")
    public sender: Partner;

    // @DataMember(Name="receiver")
    public receiver: Partner;

    public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}

export class AvpList
{
    public code: string;
    public value: string;

    public constructor(init?: Partial<AvpList>) { (Object as any).assign(this, init); }
}

export class Ecom_PartyIdentificationType
{
    public gln: string;
    public name: string;
    public additionalPartyIdentification: AvpList[] = [];

    public constructor(init?: Partial<Ecom_PartyIdentificationType>) { (Object as any).assign(this, init); }
}

export class CommunicationChannel
{
    public communicationChannelCode: string;
    public communicationChannelName: string;
    public communicationValue: string;

    public constructor(init?: Partial<CommunicationChannel>) { (Object as any).assign(this, init); }
}

export class Contact
{
    public contactTypeCode: string;
    public personName: string;
    public departmentName: string;
    public jobTitle: string;
    public responsibility: string;
    public communicationChannel: CommunicationChannel[] = [];

    public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}

export class Address
{
    public streetAddressOne: string;
    public streetAddressTwo: string;
    public streetAddressThree: string;
    public city: string;
    public postalCode: string;
    public provinceCode: string;
    public countryCode: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export class FinancialRoutingNumber
{
    public number: string;
    public numberTypeCode: string;

    public constructor(init?: Partial<FinancialRoutingNumber>) { (Object as any).assign(this, init); }
}

export class FinancialAccount
{
    public number: string;
    public numberTypeCode: string;
    public name: string;

    public constructor(init?: Partial<FinancialAccount>) { (Object as any).assign(this, init); }
}

export class FinancialInstitutionInformation
{
    public financialInstitutionBranchName: string;
    public financialInstitutionName: string;
    public financialRoutingNumber: FinancialRoutingNumber;
    public financialAccount: FinancialAccount;
    public swiftCode: string;
    public exportersCode: string;

    public constructor(init?: Partial<FinancialInstitutionInformation>) { (Object as any).assign(this, init); }
}

export class TransactionalParty extends Ecom_PartyIdentificationType
{
    public contact: Contact[] = [];
    public address: Address;
    public communicationChannel: AvpList[] = [];
    public financialInstitutionInformation: FinancialInstitutionInformation;
    public dutyFeeTaxRegistration: string;
    public entityIdentification: string;

    public constructor(init?: Partial<TransactionalParty>) { super(init); (Object as any).assign(this, init); }
}

export enum DocumentAction
{
    ADD = 'ADD',
    CHANGE_BY_REFRESH = 'CHANGE_BY_REFRESH',
    DELETE = 'DELETE',
    REJECTED = 'REJECTED',
}

export enum DocumentStatus
{
    ADDITIONAL_TRANSMISSION = 'ADDITIONAL_TRANSMISSION',
    COPY = 'COPY',
    ORIGINAL = 'ORIGINAL',
}

export class TransactionalPartyMessageType extends TransactionalParty
{
    public creationDateTime: string;
    public lastUpdateDateTime?: string;
    public documentActionCode: DocumentAction;
    public documentStatusCode: DocumentStatus;
    public documentStructureVersion: string;
    public revisionNumber?: number;
    public avpList: AvpList[] = [];

    public constructor(init?: Partial<TransactionalPartyMessageType>) { super(init); (Object as any).assign(this, init); }
}

export class TransactionalPartyMessage
{
    public header: Header;
    public transactionalParty: TransactionalPartyMessageType;

    public constructor(init?: Partial<TransactionalPartyMessage>) { (Object as any).assign(this, init); }
}

/** @description Transactional Party */
// @Api(Description="Transactional Party")
// @ApiResponse(Description="Transactional Party data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType="typeof(ServiceStack.IReturnVoid)", StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType="typeof(System.ArgumentOutOfRangeException)", StatusCode=400)
export class GetTransactionalPartyByParam implements IGetTransactionalPartyByParam
{
    public transactionPartyGln: string;

    public constructor(init?: Partial<GetTransactionalPartyByParam>) { (Object as any).assign(this, init); }
}

TypeScript GetTransactionalPartyByParam DTOs

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

HTTP + XML

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

GET /api/transactionalParty HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TransactionalPartyMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
  <Header>
    <documentIdentification>
      <creationDateAndTime>0001-01-01T00:00:00</creationDateAndTime>
      <identifier>String</identifier>
      <type>String</type>
    </documentIdentification>
    <receiver>
      <contactInformation>
        <ContactInformation />
      </contactInformation>
      <identifier>
        <authority>String</authority>
        <text>String</text>
      </identifier>
    </receiver>
    <sender>
      <contactInformation>
        <ContactInformation />
      </contactInformation>
      <identifier>
        <authority>String</authority>
        <text>String</text>
      </identifier>
    </sender>
  </Header>
  <TransactionalParty>
    <AdditionalPartyIdentification>
      <AvpList>
        <Code>String</Code>
        <Value>String</Value>
      </AvpList>
    </AdditionalPartyIdentification>
    <Gln>String</Gln>
    <Name>String</Name>
    <Address>
      <City>String</City>
      <CountryCode>String</CountryCode>
      <PostalCode>String</PostalCode>
      <ProvinceCode>String</ProvinceCode>
      <StreetAddressOne>String</StreetAddressOne>
      <StreetAddressThree>String</StreetAddressThree>
      <StreetAddressTwo>String</StreetAddressTwo>
    </Address>
    <CommunicationChannel>
      <AvpList>
        <Code>String</Code>
        <Value>String</Value>
      </AvpList>
    </CommunicationChannel>
    <Contact>
      <Contact>
        <CommunicationChannel>
          <CommunicationChannel>
            <CommunicationChannelCode>String</CommunicationChannelCode>
            <CommunicationChannelName>String</CommunicationChannelName>
            <CommunicationValue>String</CommunicationValue>
          </CommunicationChannel>
        </CommunicationChannel>
        <ContactTypeCode>String</ContactTypeCode>
        <DepartmentName>String</DepartmentName>
        <JobTitle>String</JobTitle>
        <PersonName>String</PersonName>
        <Responsibility>String</Responsibility>
      </Contact>
    </Contact>
    <DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
    <EntityIdentification>String</EntityIdentification>
    <FinancialInstitutionInformation>
      <ExportersCode>String</ExportersCode>
      <FinancialAccount>
        <Name>String</Name>
        <Number>String</Number>
        <NumberTypeCode>String</NumberTypeCode>
      </FinancialAccount>
      <FinancialInstitutionBranchName>String</FinancialInstitutionBranchName>
      <FinancialInstitutionName>String</FinancialInstitutionName>
      <FinancialRoutingNumber>
        <Number>String</Number>
        <NumberTypeCode>String</NumberTypeCode>
      </FinancialRoutingNumber>
      <SwiftCode>String</SwiftCode>
    </FinancialInstitutionInformation>
    <AvpList>
      <AvpList>
        <Code>String</Code>
        <Value>String</Value>
      </AvpList>
    </AvpList>
    <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
    <DocumentActionCode>ADD</DocumentActionCode>
    <DocumentStatusCode>ADDITIONAL_TRANSMISSION</DocumentStatusCode>
    <DocumentStructureVersion>String</DocumentStructureVersion>
    <LastUpdateDateTime>0001-01-01T00:00:00</LastUpdateDateTime>
    <RevisionNumber>0</RevisionNumber>
  </TransactionalParty>
</TransactionalPartyMessage>