| GET | /api/debitNote/type/{Type} | Get paged debit note response by type |
|---|
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>
///Debit Note
///</summary>
[<Api(Description="Debit Note")>]
[<ApiResponse(Description="Paged debit note response by type", IsDefaultResponse=true, StatusCode=200)>]
[<AllowNullLiteral>]
type GetDebitNoteByType() =
///<summary>
///Not used
///</summary>
[<ApiMember(Description="Not used")>]
member val SearchTerm:String = null with get,set
///<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>
///Debit Note type to be returned
///</summary>
[<ApiMember(Description="Debit Note type to be returned", ExcludeInSchema=true, ParameterType="path")>]
member val Type:String = null 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/debitNote/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":[{}]}