DX STF Client API

<back to all web services

GetOrderByDateRange

Order Requests

Order

Requires Authentication
The following routes are available for this service:
GET/api/order/from/{FromDate}/to/{ToDate}Get invoice between start and end date
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


# @Api(Description="Order")
# @ApiResponse(Description="Paged invoice response between start and end date", IsDefaultResponse=true, StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOrderByDateRange:
    """
    Order
    """

    # @ApiMember(Description="Requested page number, starting at 1")
    requested_page: int = 0
    """
    Requested page number, starting at 1
    """


    # @ApiMember(Description="Number of records to return on a page")
    number_of_records_per_page: int = 0
    """
    Number of records to return on a page
    """


    # @ApiMember(Description="From Date Time", ParameterType="path")
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    From Date Time
    """


    # @ApiMember(Description="To Date Time", ParameterType="path")
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    To Date Time
    """


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagedQueryResult(Generic[T]):
    start_index: int = 0
    end_index: int = 0
    number_of_records_returned: int = 0
    total_number_of_pages: int = 0
    total_number_of_records: int = 0
    results: List[ResultItem[ClaimMessage]] = field(default_factory=list)

Python GetOrderByDateRange 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/order/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: 
	[
		{
			
		}
	]
}