DX STF Client API

SearchItemDataNotification

Item Data Notification Requests

Item Data Notification

The following routes are available for this service:
POST	/api/itemDataNotification/search	Search item data notification based on search parameters

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Item Data Notification
*/
@Api(Description="Item Data Notification")
@ApiResponse(Description="Paged ItemDataNotification data", IsDefaultResponse=true, ResponseType=0, Culture=neutral, PublicKeyToken=null]]::class, StatusCode=200)
open class SearchItemDataNotification
{
    /**
    * Search query
    */
    @ApiMember(Description="Search query", ParameterType="model")
    open var query:SearchItemDataNotificationQuery? = null
}

open class SearchItemDataNotificationQuery : ISearchItemDataNotification
{
    open var receiverGln:String? = null
    open var senderGln:String? = null
    open var partnerGln:ArrayList<String> = ArrayList<String>()
    open var requestedPage:Int? = null
    open var numberOfRecordsPerPage:Int? = null
    override var continuationToken:String? = null
    override var categoryCode:String? = null
    override var identifier:String? = null
    open var tradeItemDescription:String? = null
    open var gtin:String? = null
    open var orderBy:String? = null
    open var order:ORDER? = null
}

enum class ORDER
{
    Asc,
    Desc,
}

open class PagedQueryResponseWithToken<T> : PagedQueryResult<ResultItem<InvoiceMessage>>()
{
    open var continuationToken:String? = null
}

open class PagedQueryResult<T>
{
    open var startIndex:Long? = null
    open var endIndex:Long? = null
    open var numberOfRecordsReturned:Int? = null
    open var totalNumberOfPages:Int? = null
    open var totalNumberOfRecords:Long? = null
    open var results:ArrayList<ResultItem<ClaimMessage>> = ArrayList<ResultItem<ClaimMessage>>()
}

Kotlin SearchItemDataNotification DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{"continuationToken":"String","startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}