DX STF Client API

<back to all web services

GetTransactionalPartyById

Transactional Party

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.TransactionalParty
Imports DX.STF.Models.Dto.GS1

Namespace Global

    Namespace DX.STF.Application.ClientApi.Messages.TransactionalParty

        '''<Summary>
        '''Transactional Party
        '''</Summary>
        <Api(Description:="Transactional Party")>
        <ApiResponse(Description:="transactionalParty data", IsDefaultResponse:=true, StatusCode:=200)>
        <ApiResponse(Description:="No Content", ResponseType:=GetType(IReturnVoid), StatusCode:=204)>
        <ApiResponse(Description:="Specified argument was out of the range of valid values.", ResponseType:=GetType(ArgumentOutOfRangeException), StatusCode:=400)>
        Public Partial Class GetTransactionalPartyById
            Implements IGetDocumentById
            '''<Summary>
            '''transactionalParty ID or Token
            '''</Summary>
            <ApiMember(Description:="transactionalParty ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property Id As Guid
        End Class
    End Namespace

    Namespace DX.STF.Models.Dto.GS1

        Public Partial Class Address
            Public Overridable Property StreetAddressOne As String
            Public Overridable Property StreetAddressTwo As String
            Public Overridable Property StreetAddressThree As String
            Public Overridable Property City As String
            Public Overridable Property PostalCode As String
            Public Overridable Property ProvinceCode As String
            Public Overridable Property CountryCode As String
        End Class

        Public Partial Class AvpList
            Public Overridable Property Code As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class CommunicationChannel
            Public Overridable Property CommunicationChannelCode As String
            Public Overridable Property CommunicationChannelName As String
            Public Overridable Property CommunicationValue As String
        End Class

        Public Partial Class Contact
            Public Overridable Property ContactTypeCode As String
            Public Overridable Property PersonName As String
            Public Overridable Property DepartmentName As String
            Public Overridable Property JobTitle As String
            Public Overridable Property Responsibility As String
            Public Overridable Property CommunicationChannel As List(Of CommunicationChannel) = New List(Of CommunicationChannel)
        End Class

        <DataContract>
        Public Partial Class ContactInformation
        End Class

        Public Enum DocumentAction
            ADD
            CHANGE_BY_REFRESH
            DELETE
            REJECTED
        End Enum

        <DataContract>
        Public Partial Class DocumentIdentification
            <DataMember(Name:="identifier")>
            Public Overridable Property Identifier As String

            <DataMember(Name:="type")>
            Public Overridable Property Type As String

            <DataMember(Name:="creationDateAndTime")>
            Public Overridable Property CreationDateAndTime As Date
        End Class

        Public Enum DocumentStatus
            ADDITIONAL_TRANSMISSION
            COPY
            ORIGINAL
        End Enum

        Public Partial Class Ecom_PartyIdentificationType
            Public Overridable Property Gln As String
            Public Overridable Property Name As String
            Public Overridable Property AdditionalPartyIdentification As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class FinancialAccount
            Public Overridable Property Number As String
            Public Overridable Property NumberTypeCode As String
            Public Overridable Property Name As String
        End Class

        Public Partial Class FinancialInstitutionInformation
            Public Overridable Property FinancialInstitutionBranchName As String
            Public Overridable Property FinancialInstitutionName As String
            Public Overridable Property FinancialRoutingNumber As FinancialRoutingNumber
            Public Overridable Property FinancialAccount As FinancialAccount
            Public Overridable Property SwiftCode As String
            Public Overridable Property ExportersCode As String
        End Class

        Public Partial Class FinancialRoutingNumber
            Public Overridable Property Number As String
            Public Overridable Property NumberTypeCode As String
        End Class

        <DataContract>
        Public Partial Class Header
            <DataMember(Name:="documentIdentification")>
            Public Overridable Property DocumentIdentification As DocumentIdentification

            <DataMember(Name:="sender")>
            Public Overridable Property Sender As Partner

            <DataMember(Name:="receiver")>
            Public Overridable Property Receiver As Partner
        End Class

        <DataContract>
        Public Partial Class Identifier
            <DataMember(Name:="authority")>
            Public Overridable Property Authority As String

            <DataMember(Name:="text")>
            Public Overridable Property Text As String
        End Class

        <DataContract>
        Public Partial Class Partner
            <DataMember(Name:="identifier")>
            Public Overridable Property Identifier As Identifier

            <DataMember(Name:="contactInformation")>
            Public Overridable Property ContactInformation As List(Of ContactInformation) = New List(Of ContactInformation)
        End Class

        Public Partial Class TransactionalParty
            Inherits Ecom_PartyIdentificationType
            Public Overridable Property Contact As List(Of Contact) = New List(Of Contact)
            Public Overridable Property Address As Address
            Public Overridable Property CommunicationChannel As List(Of AvpList) = New List(Of AvpList)
            Public Overridable Property FinancialInstitutionInformation As FinancialInstitutionInformation
            Public Overridable Property DutyFeeTaxRegistration As String
            Public Overridable Property EntityIdentification As String
        End Class

        Public Partial Class TransactionalPartyMessage
            Public Overridable Property Header As Header
            Public Overridable Property TransactionalParty As TransactionalPartyMessageType
        End Class

        Public Partial Class TransactionalPartyMessageType
            Inherits TransactionalParty
            Public Overridable Property CreationDateTime As Date
            Public Overridable Property LastUpdateDateTime As Date?
            Public Overridable Property DocumentActionCode As DocumentAction
            Public Overridable Property DocumentStatusCode As DocumentStatus
            Public Overridable Property DocumentStructureVersion As String
            Public Overridable Property RevisionNumber As Long?
            Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
        End Class
    End Namespace
End Namespace

VB.NET GetTransactionalPartyById DTOs

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}}