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 .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.

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

{
	RouteId: 0,
	Page: 0,
	NumRowPerPage: 0,
	Locale: vi-VN,
	Version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			ID: 0,
			Pickup: 0,
			PickupStreet: False,
			Preparatory: String,
			Street: String,
			Note: String,
			Distance: 0,
			Duration: 0,
			XCoordinates: String,
			YCoordinates: String
		}
	],
	TotalRecord: 0,
	Status: 0,
	Message: String
}