| POST | /api/transactionalParty | Add new transactional party |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.TransactionalParty;
using DX.STF.Models.Dto.GS1;
using DX.Framework.Core.Commands.Dto;
namespace DX.Framework.Core.Commands.Dto
{
public partial class TokenDto
: ICommandResponse
{
public virtual Guid Token { get; set; }
}
}
namespace DX.STF.Application.ClientApi.Messages.TransactionalParty
{
///<summary>
///Transactional Party
///</summary>
[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)]
public partial class AddTransactionalParty
{
///<summary>
///Transactional Party model containing all of the transactional party data
///</summary>
[ApiMember(Description="Transactional Party model containing all of the transactional party data", ParameterType="model")]
public virtual TransactionalPartyMessage TransactionalParty { get; set; }
}
}
namespace DX.STF.Models.Dto.GS1
{
public partial class Address
{
public virtual string StreetAddressOne { get; set; }
public virtual string StreetAddressTwo { get; set; }
public virtual string StreetAddressThree { get; set; }
public virtual string City { get; set; }
public virtual string PostalCode { get; set; }
public virtual string ProvinceCode { get; set; }
public virtual string CountryCode { get; set; }
}
public partial class AvpList
{
public virtual string Code { get; set; }
public virtual string Value { get; set; }
}
public partial class CommunicationChannel
{
public virtual string CommunicationChannelCode { get; set; }
public virtual string CommunicationChannelName { get; set; }
public virtual string CommunicationValue { get; set; }
}
public partial class Contact
{
public virtual string ContactTypeCode { get; set; }
public virtual string PersonName { get; set; }
public virtual string DepartmentName { get; set; }
public virtual string JobTitle { get; set; }
public virtual string Responsibility { get; set; }
public virtual List<CommunicationChannel> CommunicationChannel { get; set; } = [];
}
[DataContract]
public partial class ContactInformation
{
}
public enum DocumentAction
{
ADD,
CHANGE_BY_REFRESH,
DELETE,
REJECTED,
}
[DataContract]
public partial class DocumentIdentification
{
[DataMember(Name="identifier")]
public virtual string Identifier { get; set; }
[DataMember(Name="type")]
public virtual string Type { get; set; }
[DataMember(Name="creationDateAndTime")]
public virtual DateTime CreationDateAndTime { get; set; }
}
public enum DocumentStatus
{
ADDITIONAL_TRANSMISSION,
COPY,
ORIGINAL,
}
public partial class Ecom_PartyIdentificationType
{
public virtual string Gln { get; set; }
public virtual string Name { get; set; }
public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
}
public partial class FinancialAccount
{
public virtual string Number { get; set; }
public virtual string NumberTypeCode { get; set; }
public virtual string Name { get; set; }
}
public partial class FinancialInstitutionInformation
{
public virtual string FinancialInstitutionBranchName { get; set; }
public virtual string FinancialInstitutionName { get; set; }
public virtual FinancialRoutingNumber FinancialRoutingNumber { get; set; }
public virtual FinancialAccount FinancialAccount { get; set; }
public virtual string SwiftCode { get; set; }
public virtual string ExportersCode { get; set; }
}
public partial class FinancialRoutingNumber
{
public virtual string Number { get; set; }
public virtual string NumberTypeCode { get; set; }
}
[DataContract]
public partial class Header
{
[DataMember(Name="documentIdentification")]
public virtual DocumentIdentification DocumentIdentification { get; set; }
[DataMember(Name="sender")]
public virtual Partner Sender { get; set; }
[DataMember(Name="receiver")]
public virtual Partner Receiver { get; set; }
}
[DataContract]
public partial class Identifier
{
[DataMember(Name="authority")]
public virtual string Authority { get; set; }
[DataMember(Name="text")]
public virtual string Text { get; set; }
}
[DataContract]
public partial class Partner
{
[DataMember(Name="identifier")]
public virtual Identifier Identifier { get; set; }
[DataMember(Name="contactInformation")]
public virtual List<ContactInformation> ContactInformation { get; set; } = [];
}
public partial class TransactionalParty
: Ecom_PartyIdentificationType
{
public virtual List<Contact> Contact { get; set; } = [];
public virtual Address Address { get; set; }
public virtual List<AvpList> CommunicationChannel { get; set; } = [];
public virtual FinancialInstitutionInformation FinancialInstitutionInformation { get; set; }
public virtual string DutyFeeTaxRegistration { get; set; }
public virtual string EntityIdentification { get; set; }
}
public partial class TransactionalPartyMessage
{
public virtual Header Header { get; set; }
public virtual TransactionalPartyMessageType TransactionalParty { get; set; }
}
public partial class TransactionalPartyMessageType
: TransactionalParty
{
public virtual DateTime CreationDateTime { get; set; }
public virtual DateTime? LastUpdateDateTime { get; set; }
public virtual DocumentAction DocumentActionCode { get; set; }
public virtual DocumentStatus DocumentStatusCode { get; set; }
public virtual string DocumentStructureVersion { get; set; }
public virtual long? RevisionNumber { get; set; }
public virtual List<AvpList> AvpList { get; set; } = [];
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length
{}