DX STF Client API

<back to all web services

GetSettlementByDateRange

Settlement Requests

Settlement

Requires Authentication
The following routes are available for this service:
GET/api/settlement/from/{FromDate}/to/{ToDate}Get settlement between start and end date
import Foundation
import ServiceStack

/**
* Settlement
*/
// @Api(Description="Settlement")
// @ApiResponse(Description="Paged settlement response between start and end date", IsDefaultResponse=true, StatusCode=200)
public class GetSettlementByDateRange : Codable
{
    /**
    * 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

    /**
    * From Date Time
    */
    // @ApiMember(Description="From Date Time", ParameterType="path")
    public var fromDate:Date

    /**
    * To Date Time
    */
    // @ApiMember(Description="To Date Time", ParameterType="path")
    public var toDate:Date

    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(){}
}


Swift GetSettlementByDateRange DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/settlement/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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