DX STF Client API

<back to all web services

GetDebitNoteByType

Debit Note Requests

Debit Note

Requires Authentication
The following routes are available for this service:
GET/api/debitNote/type/{Type}Get paged debit note response by type
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
Imports DX.Framework.Core.Querying

Namespace Global

    Namespace DX.Framework.Core.Querying

        Public Partial Class PagedQueryResult(Of T)
            Public Overridable Property StartIndex As Long
            Public Overridable Property EndIndex As Long
            Public Overridable Property NumberOfRecordsReturned As Integer
            Public Overridable Property TotalNumberOfPages As Integer
            Public Overridable Property TotalNumberOfRecords As Long
            Public Overridable Property Results As List(Of ResultItem(Of ClaimMessage)) = New List(Of ResultItem(Of ClaimMessage))
        End Class
    End Namespace

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

        '''<Summary>
        '''Debit Note
        '''</Summary>
        <Api(Description:="Debit Note")>
        <ApiResponse(Description:="Paged debit note response by type", IsDefaultResponse:=true, StatusCode:=200)>
        Public Partial Class GetDebitNoteByType
            '''<Summary>
            '''Not used
            '''</Summary>
            <ApiMember(Description:="Not used")>
            Public Overridable Property SearchTerm As String

            '''<Summary>
            '''Requested page number, starting at 1
            '''</Summary>
            <ApiMember(Description:="Requested page number, starting at 1")>
            Public Overridable Property RequestedPage As Integer

            '''<Summary>
            '''Number of records to return on a page
            '''</Summary>
            <ApiMember(Description:="Number of records to return on a page")>
            Public Overridable Property NumberOfRecordsPerPage As Integer

            '''<Summary>
            '''Debit Note type to be returned
            '''</Summary>
            <ApiMember(Description:="Debit Note type to be returned", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property Type As String
        End Class
    End Namespace
End Namespace

VB.NET GetDebitNoteByType DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/debitNote/type/{Type} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json

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

{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}