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

**SearchItemDataNotification** Parameters:
Name	Parameter	Data Type	Required	Description
Query	model	SearchItemDataNotificationQuery	Yes	Search query

**SearchItemDataNotificationQuery** Parameters:
Name	Parameter	Data Type	Required
ReceiverGln	form	string	Yes
SenderGln	form	string	Yes
PartnerGln	form	List<string>	Yes
RequestedPage	form	int	No
NumberOfRecordsPerPage	form	int	No
ContinuationToken	form	string	Yes
CategoryCode	form	string	Yes
Identifier	form	string	Yes
TradeItemDescription	form	string	Yes
Gtin	form	string	Yes
OrderBy	form	string	Yes
Order	form	ORDER	No

**ORDER** Enum:
ASC
DESC

**PagedQueryResponseWithToken<T>** Parameters:
Name	Parameter	Data Type	Required	Description
ContinuationToken	form	string	Yes

**PagedQueryResult<T>** Parameters:
Name	Parameter	Data Type	Required
StartIndex	form	long	No
EndIndex	form	long	No
NumberOfRecordsReturned	form	int	No
TotalNumberOfPages	form	int	No
TotalNumberOfRecords	form	long	No
Results	form	List<ResultItem<ClaimMessage>>	Yes

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

HTTP + 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: 
	[
		{
			
		}
	]
}