| POST | /api/transactionalParty | Add new transactional party |
|---|
export class TokenDto implements ICommandResponse
{
public token: string;
public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}
// @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="Add Transactional Party request received", IsDefaultResponse=true, StatusCode=202)
// @ApiResponse(Description="Transactional Party not accepted, Confirm Sender GLN", ResponseType="typeof(System.UnauthorizedAccessException)", StatusCode=403)
export class AddTransactionalParty
{
/** @description Transactional Party model containing all of the transactional party data */
// @ApiMember(Description="Transactional Party model containing all of the transactional party data", ParameterType="model")
public transactionalParty: TransactionalPartyMessage;
public constructor(init?: Partial<AddTransactionalParty>) { (Object as any).assign(this, init); }
}
TypeScript AddTransactionalParty DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/transactionalParty HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
transactionalParty:
{
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
}
]
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}