| POST | /api/claim/search | Search for claims based on parameters |
|---|
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.Claim
Imports DX.STF.Models.Queries.Claim
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.Claim
'''<Summary>
'''Claim
'''</Summary>
<Api(Description:="Claim")>
<ApiResponse(Description:="Claim search results", StatusCode:=200)>
Public Partial Class SearchClaim
<ApiMember(ParameterType:="model")>
Public Overridable Property Query As SearchClaimQuery
End Class
End Namespace
Namespace DX.STF.Models.Queries.Claim
Public Partial Class _Buyer
Implements IBuyer
Public Overridable Property Gln As String Implements IBuyer.Gln
End Class
Public Partial Class _ClaimNotification
Implements IClaimNotification
Public Overridable Property EntityIdentification As String Implements IClaimNotification.EntityIdentification
End Class
Public Partial Class _Invoice
Implements IInvoice
Public Overridable Property EntityIdentification As String Implements IInvoice.EntityIdentification
End Class
Public Partial Class SearchClaimQuery
Public Overridable Property ReceiverGln As String
Public Overridable Property FromDate As Date
Public Overridable Property ToDate As Date
Public Overridable Property ClaimsNotificationTypeCode As String
Public Overridable Property ClaimsNotificationIdentification As String
Public Overridable Property Buyer As _Buyer
Public Overridable Property ClaimNotification As _ClaimNotification
Public Overridable Property Invoice As _Invoice
Public Overridable Property ExcludeLinkedToCreditNote As Boolean
Public Overridable Property SenderGln As String
Public Overridable Property PartnerGln As List(Of String) = New List(Of String)
Public Overridable Property RequestedPage As Integer
Public Overridable Property NumberOfRecordsPerPage As Integer
End Class
End Namespace
End Namespace
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.
POST /api/claim/search HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"query":{"receiverGln":"String","claimsNotificationTypeCode":"String","claimsNotificationIdentification":"String","buyer":{"gln":"String"},"claimNotification":{"entityIdentification":"String"},"invoice":{"entityIdentification":"String"},"excludeLinkedToCreditNote":false,"senderGln":"String","partnerGln":["String"],"requestedPage":0,"numberOfRecordsPerPage":0}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}