| GET | /api/creditNote/type/{Type} | Get paged credit 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.CreditNote
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.CreditNote
'''<Summary>
'''Credit Note
'''</Summary>
<Api(Description:="Credit Note")>
<ApiResponse(Description:="Paged credit note response by type", IsDefaultResponse:=true, StatusCode:=200)>
Public Partial Class GetCreditNoteByType
'''<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>
'''Credit Note type to be returned
'''</Summary>
<ApiMember(Description:="Credit Note type to be returned", ExcludeInSchema:=true, ParameterType:="path")>
Public Overridable Property Type As String
End Class
End Namespace
End Namespace
VB.NET GetCreditNoteByType DTOs
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.
GET /api/creditNote/type/{Type} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}