| POST | /api/itemDataNotification/search | Search item data notification based on search 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
type ORDER =
| ASC = 0
| DESC = 1
[<AllowNullLiteral>]
type SearchItemDataNotificationQuery() =
member val ReceiverGln:String = null 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
member val ContinuationToken:String = null with get,set
member val CategoryCode:String = null with get,set
member val Identifier:String = null with get,set
member val TradeItemDescription:String = null with get,set
member val Gtin:String = null with get,set
member val OrderBy:String = null with get,set
member val Order:ORDER = new ORDER() with get,set
///<summary>
///Item Data Notification
///</summary>
[<Api(Description="Item Data Notification")>]
[<ApiResponse(Description="Paged ItemDataNotification data", IsDefaultResponse=true, ResponseType=typeof<0, Culture=neutral, PublicKeyToken=null]]>, StatusCode=200)>]
[<AllowNullLiteral>]
type SearchItemDataNotification() =
///<summary>
///Search query
///</summary>
[<ApiMember(Description="Search query", ParameterType="model")>]
member val Query:SearchItemDataNotificationQuery = 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
[<AllowNullLiteral>]
type PagedQueryResponseWithToken<T>() =
inherit PagedQueryResult<ResultItem<InvoiceMessage>>()
member val ContinuationToken:String = null with get,set
F# SearchItemDataNotification 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.
POST /api/itemDataNotification/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","senderGln":"String","partnerGln":["String"],"requestedPage":0,"numberOfRecordsPerPage":0,"continuationToken":"String","categoryCode":"String","identifier":"String","tradeItemDescription":"String","gtin":"String","orderBy":"String","order":"ASC"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"continuationToken":"String","startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}