POST api/TripPoints
API interface handling generic JSON requests for TripPoints
Request Information
URI Parameters
None.
Body Parameters
TripPointRequest
TripPointRequestName | Description | Type | Additional information |
---|---|---|---|
Id |
Request specified appointment by Id |
integer |
None. |
Postcode |
Match clients with postcode (can match a s single "code" OR list (i.e. "code,code,...") OR range of names (i.e. "code:code")) |
string |
None. |
Limit |
Limit to number of rows returned by request (default is 100) |
integer |
None. |
Skip |
Number of rows to skip (so we can skip 10 get next 10 etc) |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": 707, "Postcode": "4000", "Limit": 534, "Skip": 581 }
application/xml, text/xml
Sample:
<TripPointRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <Id>707</Id> <Limit>534</Limit> <Postcode>4000</Postcode> <Skip>581</Skip> </TripPointRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TripPointReportDetails()
TripPointReportDetailsName | Description | Type | Additional information |
---|---|---|---|
tripPointID | integer |
None. |
|
tripPointName | string |
None. |
|
tripPointType | integer |
None. |
|
tripPointAddress | string |
None. |
|
tripPointSuburb | string |
None. |
|
tripPointState | string |
None. |
|
tripPoinPostcode | string |
None. |
|
tripPointCoords1 | string |
None. |
|
tripPointCoords2 | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "tripPointID": 291, "tripPointName": "sample string 2", "tripPointType": 303, "tripPointAddress": "sample string 3", "tripPointSuburb": "sample string 4", "tripPointState": "sample string 5", "tripPoinPostcode": "sample string 6", "tripPointCoords1": "sample string 7", "tripPointCoords2": "sample string 8" }
application/xml, text/xml
Sample:
<TripPointReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <tripPoinPostcode>sample string 6</tripPoinPostcode> <tripPointAddress>sample string 3</tripPointAddress> <tripPointCoords1>sample string 7</tripPointCoords1> <tripPointCoords2>sample string 8</tripPointCoords2> <tripPointID>291</tripPointID> <tripPointName>sample string 2</tripPointName> <tripPointState>sample string 5</tripPointState> <tripPointSuburb>sample string 4</tripPointSuburb> <tripPointType>303</tripPointType> </TripPointReportDetails>