| POST | /api/claim/search | Search for claims based on parameters |
|---|
namespace DX.Framework.Core.Querying
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type _Buyer() =
member val Gln:String = null with get,set
[<AllowNullLiteral>]
type _ClaimNotification() =
member val EntityIdentification:String = null with get,set
[<AllowNullLiteral>]
type _Invoice() =
member val EntityIdentification:String = null with get,set
[<AllowNullLiteral>]
type SearchClaimQuery() =
member val ReceiverGln:String = null with get,set
member val FromDate:DateTime = new DateTime() with get,set
member val ToDate:DateTime = new DateTime() with get,set
member val ClaimsNotificationTypeCode:String = null with get,set
member val ClaimsNotificationIdentification:String = null with get,set
member val Buyer:_Buyer = null with get,set
member val ClaimNotification:_ClaimNotification = null with get,set
member val Invoice:_Invoice = null with get,set
member val ExcludeLinkedToCreditNote:Boolean = new Boolean() with get,set
member val SenderGln:String = null with get,set
member val PartnerGln:ResizeArray<String> = null with get,set
member val RequestedPage:Int32 = new Int32() with get,set
member val NumberOfRecordsPerPage:Int32 = new Int32() with get,set
///<summary>
///Claim
///</summary>
[<Api(Description="Claim")>]
[<ApiResponse(Description="Claim search results", StatusCode=200)>]
[<AllowNullLiteral>]
type SearchClaim() =
[<ApiMember(ParameterType="model")>]
member val Query:SearchClaimQuery = null with get,set
[<AllowNullLiteral>]
type PagedQueryResult<T>() =
member val StartIndex:Int64 = new Int64() with get,set
member val EndIndex:Int64 = new Int64() with get,set
member val NumberOfRecordsReturned:Int32 = new Int32() with get,set
member val TotalNumberOfPages:Int32 = new Int32() with get,set
member val TotalNumberOfRecords:Int64 = new Int64() with get,set
member val Results:ResizeArray<ResultItem<ClaimMessage>> = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
startIndex: 0,
endIndex: 0,
numberOfRecordsReturned: 0,
totalNumberOfPages: 0,
totalNumberOfRecords: 0,
results:
[
{
}
]
}