| GET | /api/debitNote/from/{FromDate}/to/{ToDate} | Get debit note between start and end date |
|---|
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 between start and end date", IsDefaultResponse:=true, StatusCode:=200)>
Public Partial Class GetDebitNoteByDateRange
'''<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>
'''From Date Time
'''</Summary>
<ApiMember(Description:="From Date Time", ParameterType:="path")>
Public Overridable Property FromDate As Date
'''<Summary>
'''To Date Time
'''</Summary>
<ApiMember(Description:="To Date Time", ParameterType:="path")>
Public Overridable Property ToDate As Date
End Class
End Namespace
End Namespace
VB.NET GetDebitNoteByDateRange DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/debitNote/from/{FromDate}/to/{ToDate} 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
{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}