| POST | /api/itemDataNotification/search | Search item data notification based on search parameters |
|---|
export enum ORDER
{
ASC = 'ASC',
DESC = 'DESC',
}
export class SearchItemDataNotificationQuery implements ISearchItemDataNotification
{
public receiverGln: string;
public senderGln: string;
public partnerGln: string[] = [];
public requestedPage: number;
public numberOfRecordsPerPage: number;
public continuationToken: string;
public categoryCode: string;
public identifier: string;
public tradeItemDescription: string;
public gtin: string;
public orderBy: string;
public order: ORDER;
public constructor(init?: Partial<SearchItemDataNotificationQuery>) { (Object as any).assign(this, init); }
}
/** @description Item Data Notification */
// @Api(Description="Item Data Notification")
// @ApiResponse(Description="Paged ItemDataNotification data", IsDefaultResponse=true, ResponseType="typeof(DX.STF.Models.Queries.QueryResult.PagedQueryResponseWithToken`1[[DX.Framework.Core.Querying.ResultItem`1[[DX.STF.Models.Dto.GS1.ItemDataNotificationMessage, DX.STF.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], DX.Framework.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]])", StatusCode=200)
export class SearchItemDataNotification
{
/** @description Search query */
// @ApiMember(Description="Search query", ParameterType="model")
public query: SearchItemDataNotificationQuery;
public constructor(init?: Partial<SearchItemDataNotification>) { (Object as any).assign(this, init); }
}
export class PagedQueryResult<T>
{
public startIndex: number;
public endIndex: number;
public numberOfRecordsReturned: number;
public totalNumberOfPages: number;
public totalNumberOfRecords: number;
public results: ResultItem<ClaimMessage>[] = [];
public constructor(init?: Partial<PagedQueryResult<T>>) { (Object as any).assign(this, init); }
}
export class PagedQueryResponseWithToken<T> extends PagedQueryResult<ResultItem<InvoiceMessage>>
{
public continuationToken: string;
public constructor(init?: Partial<PagedQueryResponseWithToken<T>>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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:
[
{
}
]
}