| GET | /api/order/type/{Type} | Get paged order response by order type |
|---|
/** @description Order */
// @Api(Description="Order")
// @ApiResponse(Description="Paged order response by order type", IsDefaultResponse=true, StatusCode=200)
export class GetOrderByType
{
/** @description Not used */
// @ApiMember(Description="Not used")
public searchTerm: string;
/** @description Requested page number, starting at 1 */
// @ApiMember(Description="Requested page number, starting at 1")
public requestedPage: number;
/** @description Number of records to return on a page */
// @ApiMember(Description="Number of records to return on a page")
public numberOfRecordsPerPage: number;
/** @description Order type to be returned */
// @ApiMember(Description="Order type to be returned", ExcludeInSchema=true, ParameterType="path")
public type: string;
public constructor(init?: Partial<GetOrderByType>) { (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); }
}
TypeScript GetOrderByType 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.
GET /api/order/type/{Type} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}