DX STF Client API

<back to all web services

GetOrderResponseByDateRange

Order Response Requests

Order Response

Requires Authentication
The following routes are available for this service:
GET/api/orderResponse/from/{FromDate}/to/{ToDate}Get Order Response between start and end date
namespace DX.Framework.Core.Querying

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Order Response
    ///</summary>
    [<Api(Description="Order Response")>]
    [<ApiResponse(Description="Paged Order Response response between start and end date", IsDefaultResponse=true, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetOrderResponseByDateRange() = 
        ///<summary>
        ///Requested page number, starting at 1
        ///</summary>
        [<ApiMember(Description="Requested page number, starting at 1")>]
        member val RequestedPage:Int32 = new Int32() with get,set

        ///<summary>
        ///Number of records to return on a page
        ///</summary>
        [<ApiMember(Description="Number of records to return on a page")>]
        member val NumberOfRecordsPerPage:Int32 = new Int32() with get,set

        ///<summary>
        ///From Date Time
        ///</summary>
        [<ApiMember(Description="From Date Time", ParameterType="path")>]
        member val FromDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///To Date Time
        ///</summary>
        [<ApiMember(Description="To Date Time", ParameterType="path")>]
        member val ToDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PagedQueryResult<T>() = 
        member val StartIndex:Int64 = new Int64() with get,set
        member val EndIndex:Int64 = new Int64() with get,set
        member val NumberOfRecordsReturned:Int32 = new Int32() with get,set
        member val TotalNumberOfPages:Int32 = new Int32() with get,set
        member val TotalNumberOfRecords:Int64 = new Int64() with get,set
        member val Results:ResizeArray<ResultItem<ClaimMessage>> = null with get,set

F# GetOrderResponseByDateRange 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/orderResponse/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: 
	[
		{
			
		}
	]
}