DX STF Client API

<back to all web services

AcknowledgeDebitNote

Debit Note Requests

Debit Note

Requires Authentication
The following routes are available for this service:
PUT/api/debitNote/{DebitNoteId}/acknowledgeAcknowledge debit note as received
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.DebitNote

Namespace Global

    Namespace DX.STF.Application.ClientApi.Messages.DebitNote

        '''<Summary>
        '''Debit Note
        '''</Summary>
        <Api(Description:="Debit Note")>
        <ApiResponse(Description:="Updated", IsDefaultResponse:=true, StatusCode:=204)>
        <ApiResponse(Description:="GLN does not have required access", StatusCode:=403)>
        <ApiResponse(Description:="Document not found", StatusCode:=404)>
        Public Partial Class AcknowledgeDebitNote
            <ApiMember(ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property DebitNoteId As Guid
        End Class
    End Namespace
End Namespace

VB.NET AcknowledgeDebitNote 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.

PUT /api/debitNote/{DebitNoteId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AcknowledgeDebitNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.DebitNote">
  <DebitNoteId>00000000-0000-0000-0000-000000000000</DebitNoteId>
</AcknowledgeDebitNote>