| GET | /api/order/type/{Type} | Get paged order response by order type |
|---|
import Foundation
import ServiceStack
/**
* Order
*/
// @Api(Description="Order")
// @ApiResponse(Description="Paged order response by order type", IsDefaultResponse=true, StatusCode=200)
public class GetOrderByType : Codable
{
/**
* Not used
*/
// @ApiMember(Description="Not used")
public var searchTerm:String
/**
* Requested page number, starting at 1
*/
// @ApiMember(Description="Requested page number, starting at 1")
public var requestedPage:Int
/**
* Number of records to return on a page
*/
// @ApiMember(Description="Number of records to return on a page")
public var numberOfRecordsPerPage:Int
/**
* Order type to be returned
*/
// @ApiMember(Description="Order type to be returned", ExcludeInSchema=true, ParameterType="path")
public var type:String
required public init(){}
}
public class PagedQueryResult<T : Codable> : Codable
{
public var startIndex:Int
public var endIndex:Int
public var numberOfRecordsReturned:Int
public var totalNumberOfPages:Int
public var totalNumberOfRecords:Int
public var results:[ResultItem<ClaimMessage>] = []
required public init(){}
}
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":[{}]}