| GET | /api/receivingAdvice/type/{Type} | Get paged ReceivingAdvice response by ReceivingAdvice 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.*;
public class dtos
{
/**
* Receiving Advice
*/
@Api(Description="Receiving Advice")
@ApiResponse(Description="Paged ReceivingAdvice response by ReceivingAdvice type", IsDefaultResponse=true, StatusCode=200)
public static class GetReceivingAdviceByType
{
/**
* 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;
/**
* ReceivingAdvice type to be returned
*/
@ApiMember(Description="ReceivingAdvice type to be returned", ExcludeInSchema=true, ParameterType="path")
public String type = null;
public String getSearchTerm() { return searchTerm; }
public GetReceivingAdviceByType setSearchTerm(String value) { this.searchTerm = value; return this; }
public Integer getRequestedPage() { return requestedPage; }
public GetReceivingAdviceByType setRequestedPage(Integer value) { this.requestedPage = value; return this; }
public Integer getNumberOfRecordsPerPage() { return numberOfRecordsPerPage; }
public GetReceivingAdviceByType setNumberOfRecordsPerPage(Integer value) { this.numberOfRecordsPerPage = value; return this; }
public String getType() { return type; }
public GetReceivingAdviceByType 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 GetReceivingAdviceByType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/receivingAdvice/type/{Type} 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:
[
{
}
]
}