| POST | /api/itemDataNotification/search | Search item data notification based on search 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.ItemDataNotification
Imports DX.STF.Models.Queries.ItemDataNotification
Imports DX.STF.Contracts.Enums
Imports DX.STF.Models.Queries.QueryResult
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.ItemDataNotification
'''<Summary>
'''Item Data Notification
'''</Summary>
<Api(Description:="Item Data Notification")>
<ApiResponse(Description:="Paged ItemDataNotification data", IsDefaultResponse:=true, ResponseType:=GetType(0, Culture=neutral, PublicKeyToken=null]]), StatusCode:=200)>
Public Partial Class SearchItemDataNotification
'''<Summary>
'''Search query
'''</Summary>
<ApiMember(Description:="Search query", ParameterType:="model")>
Public Overridable Property Query As SearchItemDataNotificationQuery
End Class
End Namespace
Namespace DX.STF.Contracts.Enums
Public Enum ORDER
ASC
DESC
End Enum
End Namespace
Namespace DX.STF.Models.Queries.ItemDataNotification
Public Partial Class SearchItemDataNotificationQuery
Implements ISearchItemDataNotification
Public Overridable Property ReceiverGln As String
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
Public Overridable Property ContinuationToken As String Implements ISearchItemDataNotification.ContinuationToken
Public Overridable Property CategoryCode As String Implements ISearchItemDataNotification.CategoryCode
Public Overridable Property Identifier As String Implements ISearchItemDataNotification.Identifier
Public Overridable Property TradeItemDescription As String
Public Overridable Property Gtin As String
Public Overridable Property OrderBy As String
Public Overridable Property Order As ORDER
End Class
End Namespace
Namespace DX.STF.Models.Queries.QueryResult
Public Partial Class PagedQueryResponseWithToken(Of T)
Inherits PagedQueryResult(Of ResultItem(Of InvoiceMessage))
Public Overridable Property ContinuationToken As String
End Class
End Namespace
End Namespace
VB.NET SearchItemDataNotification DTOs
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/itemDataNotification/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,
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/jsv
Content-Length: length
{
continuationToken: String,
startIndex: 0,
endIndex: 0,
numberOfRecordsReturned: 0,
totalNumberOfPages: 0,
totalNumberOfRecords: 0,
results:
[
{
}
]
}