DX STF Client API

<back to all web services

GetSettlementByDateRange

Settlement

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.Settlement;
using DX.Framework.Core.Querying;

namespace DX.Framework.Core.Querying
{
    public partial class PagedQueryResult<T>
    {
        public virtual long StartIndex { get; set; }
        public virtual long EndIndex { get; set; }
        public virtual int NumberOfRecordsReturned { get; set; }
        public virtual int TotalNumberOfPages { get; set; }
        public virtual long TotalNumberOfRecords { get; set; }
        public virtual List<ResultItem<ClaimMessage>> Results { get; set; } = [];
    }

}

namespace DX.STF.Application.ClientApi.Messages.Settlement
{
    ///<summary>
    ///Settlement
    ///</summary>
    [Api(Description="Settlement")]
    [ApiResponse(Description="Paged settlement response between start and end date", IsDefaultResponse=true, StatusCode=200)]
    public partial class GetSettlementByDateRange
    {
        ///<summary>
        ///Requested page number, starting at 1
        ///</summary>
        [ApiMember(Description="Requested page number, starting at 1")]
        public virtual int RequestedPage { get; set; }

        ///<summary>
        ///Number of records to return on a page
        ///</summary>
        [ApiMember(Description="Number of records to return on a page")]
        public virtual int NumberOfRecordsPerPage { get; set; }

        ///<summary>
        ///From Date Time
        ///</summary>
        [ApiMember(Description="From Date Time", ParameterType="path")]
        public virtual DateTime FromDate { get; set; }

        ///<summary>
        ///To Date Time
        ///</summary>
        [ApiMember(Description="To Date Time", ParameterType="path")]
        public virtual DateTime ToDate { get; set; }
    }

}

C# GetSettlementByDateRange DTOs

GET /api/settlement/from/{FromDate}/to/{ToDate} 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":[{}]}