| GET | /api/settlement/type/{Type} | Get paged Settlement response by Settlement 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.*
/**
* Settlement
*/
@Api(Description="Settlement")
@ApiResponse(Description="Paged Settlement response by Settlement type", IsDefaultResponse=true, StatusCode=200)
open class GetSettlementByType
{
/**
* 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
/**
* Settlement type to be returned
*/
@ApiMember(Description="Settlement 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 GetSettlementByType 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/settlement/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":[{}]}