DX STF Client API

<back to all web services

GetSettlementByType

Settlement

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Settlement
    */
    @Api(Description="Settlement")
    @ApiResponse(Description="Paged Settlement response by Settlement type", IsDefaultResponse=true, StatusCode=200)
    public static class GetSettlementByType
    {
        /**
        * Not used
        */
        @ApiMember(Description="Not used")
        public String searchTerm = null;

        /**
        * Requested page number, starting at 1
        */
        @ApiMember(Description="Requested page number, starting at 1")
        public Integer requestedPage = null;

        /**
        * Number of records to return on a page
        */
        @ApiMember(Description="Number of records to return on a page")
        public Integer numberOfRecordsPerPage = null;

        /**
        * Settlement type to be returned
        */
        @ApiMember(Description="Settlement type to be returned", ExcludeInSchema=true, ParameterType="path")
        public String type = null;
        
        public String getSearchTerm() { return searchTerm; }
        public GetSettlementByType setSearchTerm(String value) { this.searchTerm = value; return this; }
        public Integer getRequestedPage() { return requestedPage; }
        public GetSettlementByType setRequestedPage(Integer value) { this.requestedPage = value; return this; }
        public Integer getNumberOfRecordsPerPage() { return numberOfRecordsPerPage; }
        public GetSettlementByType setNumberOfRecordsPerPage(Integer value) { this.numberOfRecordsPerPage = value; return this; }
        public String getType() { return type; }
        public GetSettlementByType setType(String value) { this.type = value; return this; }
    }

    public static class PagedQueryResult<T>
    {
        public Long startIndex = null;
        public Long endIndex = null;
        public Integer numberOfRecordsReturned = null;
        public Integer totalNumberOfPages = null;
        public Long totalNumberOfRecords = null;
        public ArrayList<ResultItem<ClaimMessage>> results = new ArrayList<ResultItem<ClaimMessage>>();
        
        public Long getStartIndex() { return startIndex; }
        public PagedQueryResult<T> setStartIndex(Long value) { this.startIndex = value; return this; }
        public Long getEndIndex() { return endIndex; }
        public PagedQueryResult<T> setEndIndex(Long value) { this.endIndex = value; return this; }
        public Integer getNumberOfRecordsReturned() { return numberOfRecordsReturned; }
        public PagedQueryResult<T> setNumberOfRecordsReturned(Integer value) { this.numberOfRecordsReturned = value; return this; }
        public Integer getTotalNumberOfPages() { return totalNumberOfPages; }
        public PagedQueryResult<T> setTotalNumberOfPages(Integer value) { this.totalNumberOfPages = value; return this; }
        public Long getTotalNumberOfRecords() { return totalNumberOfRecords; }
        public PagedQueryResult<T> setTotalNumberOfRecords(Long value) { this.totalNumberOfRecords = value; return this; }
        public ArrayList<ResultItem<ClaimMessage>> getResults() { return results; }
        public PagedQueryResult<T> setResults(ArrayList<ResultItem<ClaimMessage>> value) { this.results = value; return this; }
    }

}

Java GetSettlementByType DTOs

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":[{}]}