POST api/Dispatch/TripTemplate

use this method to search for Trip Templates

Request Information

URI Parameters

None.

Body Parameters

SelectTripTemplateParm
NameDescriptionTypeAdditional information
auth

User authorization identifier

string

None.

OfficeID

Optional Office ID filter

integer

None.

Name

Optional template name parameter (wildcard % allowed)

string

None.

RouteCode

Optional route code

string

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "OfficeID": 1,
  "Name": "sample string 2",
  "RouteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<SelectTripTemplateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <Name>sample string 2</Name>
  <OfficeID>1</OfficeID>
  <RouteCode>sample string 3</RouteCode>
  <auth>sample string 1</auth>
</SelectTripTemplateParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SelectTripTemplateResp
NameDescriptionTypeAdditional information
IsSuccessful

Method was successful (true/false)

boolean

None.

ErrorMessage

If unsuccessful, the error message

string

None.

TripTemplates

List of trip templates

Collection of TripTemplateItem

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "TripTemplates": null
}

application/xml, text/xml

Sample:
<SelectTripTemplateResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <TripTemplates i:nil="true" />
</SelectTripTemplateResp>