DX STF Client API

<back to all web services

GetOrderResponseByType

Order Response Requests

Order Response

Requires Authentication
The following routes are available for this service:
GET/api/orderResponse/type/{Type}Get paged OrderResponse response by type
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Order Response
*/
@Api(Description="Order Response")
@ApiResponse(Description="Paged OrderResponse response by type", IsDefaultResponse=true, StatusCode=200)
open class GetOrderResponseByType
{
    /**
    * Not used
    */
    @ApiMember(Description="Not used")
    open var searchTerm:String? = null

    /**
    * Requested page number, starting at 1
    */
    @ApiMember(Description="Requested page number, starting at 1")
    open var requestedPage:Int? = null

    /**
    * Number of records to return on a page
    */
    @ApiMember(Description="Number of records to return on a page")
    open var numberOfRecordsPerPage:Int? = null

    /**
    * OrderResponse type to be returned
    */
    @ApiMember(Description="OrderResponse type to be returned", ExcludeInSchema=true, ParameterType="path")
    @SerializedName("type") open var Type: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 GetOrderResponseByType 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.

GET /api/orderResponse/type/{Type} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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