PT.Api

<back to all web services

QueryPickupInRoute

The following routes are available for this service:
POST/api/querypickupinroute
QueryPickupInRoute Parameters:
NameParameterData TypeRequiredDescription
RouteIdbodyintYes
LocalePaginationRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintYes
NumRowPerPageformintYes
LocaleRequest Parameters:
NameParameterData TypeRequiredDescription
LocaleformstringNoLocale. Ex: vi-VN, en-US
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintNoVersion. Ex: 1,2,3,...
QueryPickupInRouteResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<PickupInRoute>No
PaginationResponse Parameters:
NameParameterData TypeRequiredDescription
TotalRecordformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformintNoResponse status. Ex: 1 - Success; 0 - Error
MessageformstringNoResponse message
PickupInRoute Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
PickupformintNo
PickupStreetformboolNo
PreparatoryformstringNo
StreetformstringNo
NoteformstringNo
DistanceformintNo
DurationformintNo
XCoordinatesformstringNo
YCoordinatesformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/QueryPickupInRoute HTTP/1.1 
Host: api2.futabus.vn 
Content-Type: application/xml
Content-Length: length

<QueryPickupInRoute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel">
  <Version xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">0</Version>
  <Locale xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">vi-VN</Locale>
  <NumRowPerPage xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">0</NumRowPerPage>
  <Page xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">0</Page>
  <RouteId>0</RouteId>
</QueryPickupInRoute>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryPickupInRouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Types">
  <Message xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">String</Message>
  <Status xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">0</Status>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Common">0</TotalRecord>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PT.Api.ServiceModel.Types.Schedules">
    <d2p1:PickupInRoute>
      <d2p1:Distance>0</d2p1:Distance>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Pickup>0</d2p1:Pickup>
      <d2p1:PickupStreet>false</d2p1:PickupStreet>
      <d2p1:Preparatory>String</d2p1:Preparatory>
      <d2p1:Street>String</d2p1:Street>
      <d2p1:XCoordinates>String</d2p1:XCoordinates>
      <d2p1:YCoordinates>String</d2p1:YCoordinates>
    </d2p1:PickupInRoute>
  </Data>
</QueryPickupInRouteResponse>