MAS API Connec�on Informa�on

Medicaid Transporta�on
API Endpoint Documentation v5.6 2
Transportation Provider Profile 4
UpdateProviderInfo 5
MyTransportationProviderInfo 14
TransportationProviderProfile 17
Vehicle 35
ListVehicles 36
VehicleUpdate 39
FindVehicleByVIN 44
Driver 47
ListDrivers 48
GetDriver 55
NewDriver 61
UpdateDriver 64
DisableDriver 67
EnableDriver 69
Session Management 71
Trip Management 72
GPS 73
Attestation 74
Corrections 75
Informational 76
Appendix 77
Response Status 78
Token Description 83
Vehicle Type 84
String Variables 85
Correction Id Types 86
Correction Status Values 87
Mileage Upgrade Correction Values 88
Trip Status and Leg Status 89
Driver and Vehicle Reassign Status Values 90
Trip Reassign/Refusal Id Types 91
API Endpoint Documentation v5.6

‬‪Last Updated:‬‪Sep 26, 2023

Overview

The following documentation outlines endpoints which have been updated to accommodate additional elements in respect to Transportation
Provider Profile, Vehicles, and Drivers.

What can an API Connection do for a Transportation Company?

1. Integration: Can easily integrate any site or application into the API data exchange giving you the freedom to use your current system.
2. Security: Using a secure data key on all transactions ensures the integrity of the data passed between your System and the MAS
Transportation System.
3. Efficiency: Real-Time updates of information on both sides, giving you better information to run your operation.
4. Automation: Computers do the work that employees used to do, making the information flow quicker and employees more productive.

General Guidelines and System Requirements

Version This document covers up to and including version 5 of the API.
The version of the response will always match the version of the request.
The version applies only to the API structure, schema, commands, etc.

Address https://www.medanswering.com/Provider_API.taf

Encryption TLS 1.2 connections are required.

An error will be returned for any unencrypted request.

Protocol This web service uses the HTTP protocol.

All requests must use the HTTP POST verb.
All other verbs will return an error.
The required Content-Type is application/xml.
The payload is XML.

XML Encoding XML encoding is specified in the preamble.

Requests are recommended to be made with UTF-8 encoding. All responses will be returned with UTF-8
encoding.

Sessions Most API calls must be associated with a session.

A session is a group of API calls which accomplish a task or align to an event. Cookies are not required. If the
server returns a cookie, it can be ignored. Sessions will timeout if there are no calls with that session ID in 10
minutes.

Requirements An Authentication key will need to be obtained from Medical Answering Services before using API.

Timestamps Timestamps are in local time – further details in section “Token Description” {timestamp}
EXCEPTION – “Update Vehicle Location Request” uses a unique timestamp, formatted as a Unix Epoch

2
3
Transportation Provider Profile

Transportation Provider Profile APIs

The collection of Transportation Provider API endpoints get or set company information specifically related to the Transportation
Provider as a business.

For example, address, contact information, and roles, driver, vehicles, and more.

API List

UpdateProviderInfo
MyTransportationProviderInfo
TransportationProviderProfile

4
UpdateProviderInfo

UpdateProviderInfo | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

UpdateProviderInfo v1

Setter endpoint where company information like address and contact details are submitted to the company profile.

Request Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

sessionIdentifier Required Session Identifier Session Identifier

profileID Required {int} Transportation Provider (TP)

Profile Id

physicalAddress Optional {element} Physical address container

element

physicalAddress placeId Optional {shortstring} The Google place Id for the

physical address

physicalAddress address2 Optional {shortstring} Address line 2 for the

transportation provider (e.g.:
POBox, Suite, Apt#, etc)

mailingAddress Optional {element} Mailing address container

element

mailingAddress address Optional {shortstring} Mailing address for the

transportation provider

mailingAddress address2 Optional {shortstring} Mailing address line 2 for the

transportation provider

mailingAddress city Optional {shortstring} Mailing address city

mailingAddress state Optional {shortstring} Mailing address state for the

transportation provider

mailingAddress zip Optional {zipcode} Mailing address zip for the

transportation provider

ownerContact Required {element} Owner contact container element

ownerContact firstName Required {shortstring} TP Owner contact first name

ownerContact lastName Required {shortstring} TP Owner contact last name

ownerContact email Required {email} TP Owner email

ownerContact phone Required {phone} TP Owner contact phone number

5
operationsManagerContact Required {element} TP Operations Manager
container element

operationsManagerContact Required {shortstring} TP Operations Manager contact

firstName first name

operationsManagerContact Required {shortstring} TP Operations Manager contact

lastName last name

operationsManagerContact email Required {email} TP Operations Manager email

operationsManagerContact Required {phone} TP Operations Manager phone

phone number

contact1 Optional {element} TP additional contact container

element

contact1 firstName Optional {shortstring} TP additional contact first name

contact1 lastName Optional {shortstring} TP additional contact last name

contact1 email Optional {email} TP additional contact email

contact1 phone Optional {phone} TP additional contact phone

number

contact2 Optional {element} TP additional contact container

element

contact2 firstName Optional {shortstring} TP additional contact first name

contact2 lastName Optional {shortstring} TP additional contact last name

contact2 email Optional {email} TP additional contact email

contact2 phone Optional {phone} TP additional contact phone

number

routingCompanyId Optional {int} Company Id for the routing

company

billingCompanyId Optional {int} Company Id for the billing

IsTLCActive Required {bool} Is TLC active

IsGPSCapabilitiesActive Required {bool} Are GPS capabilities active

IsMASContractAgreementsCom Required {bool} Are MAS contract agreements

pleted completed

IsDrugFreeWorkplace Required {bool} Is this a drug free workplace

IsMASOrientationComplete Required {bool} Is MAS orientation complete

Request Examples

XML

1 <TPRequest>
2 <updateProviderInfo version="1">
3 <sessionIdentifier>21ed3b1e-b479-456b-9db4-b29da7b062f3</sessionIdentifier>

6
 4 <profileID>54066</profileID>
5 <physicalAddress>
6 <placeId>ChIJq8nSMdJQmoARkKra0q5qDIQ</placeId>
7 <address2>suite#138</address2>
8 </physicalAddress>
9 <mailingAddress>
10 <address>123 nowhere rd</address>
11 <address2>pobox 123</address2>
12 <city>placerville</city>
13 <state>ca</state>
14 <zip>95667</zip>
15 </mailingAddress>
16 <ownerContact>
17 <firstName>ownerFirst</firstName>
18 <lastName>ownerLast</lastName>
19 <email>[email protected]</email>
20 <phone>650-279-1234</phone>
21 </ownerContact>
22 <operationsManagerContact>
23 <firstName>operationsManagerFirst</firstName>
24 <lastName>operationsManagerLast</lastName>
25 <email>[email protected]</email>
26 <phone>650-279-5679</phone>
27 </operationsManagerContact >
28 <contact1>
29 <firstName>contact1First</firstName>
30 <lastName>contact1Last</lastName>
31 <email>[email protected]</email>
32 <phone>650-279-9012</phone>
33 </contact1>
34 <contact2>
35 <firstName>contact2First</firstName>
36 <lastName>contact2Last</lastName>
37 <email>[email protected]</email>
38 <phone>650-279-9013</phone>
39 </contact2>
40 <routingCompanyId>1</routingCompanyId>
41 <billingCompanyId>2</billingCompanyId>
42 <IsTLCActive>true</IsTLCActive>
43 <IsGPSCapabilitiesActive>true</IsGPSCapabilitiesActive>
44 <IsMASContractAgreementsCompleted>true</IsMASContractAgreementsCompleted>
45 <IsDrugFreeWorkplace>true</IsDrugFreeWorkplace>
46 <IsMASOrientationComplete>true</IsMASOrientationComplete>
47 </updateProviderInfo>
48 </TPRequest>

JSON

1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "updateProviderInfo",
5 "version": 1,
6 "profileID": 54066,
7 "physicalAddress": {
8 "placeId": "ChIJOyshvNk0wYkRydaqDAIJRNw",
9 "address2": "suite#138"
10 },

7
11 "mailingAddress": {
12 "address": "1942 ford rd",
13 "address2": null,
14 "city": "Bristol",
15 "state": "PA",
16 "zip": "19007"
17 },
18 "ownerContact": {
19 "firstName": "Mike",
20 "lastName": "Collins",
21 "email": "[email protected]",
22 "phone": "650-279-1266"
23 },
24 "operationsManagerContact": {
25 "firstName": "operationsTest",
26 "lastName": "managerTest",
27 "email": "[email protected]",
28 "phone": "650-279-1288"
29 },
30 "contact1": {
31 "firstName": "testContact1",
32 "lastName": "testersonContact1",
33 "email": "[email protected]",
34 "phone": "650-279-6577"
35 },
36 "contact2": {
37 "firstName": "testContact2",
38 "lastName": "testersonContact2",
39 "email": "[email protected]",
40 "phone": "650-279-6588"
41 },
42 "routingCompanyId": 1,
43 "billingCompanyId": 2,
44 "IsTLCActive": true,
45 "IsGPSCapabilitiesActive" : true,
46 "IsMASContractAgreementsCompleted": true,
47 "IsDrugFreeWorkplace": true,
48 "IsMASOrientationComplete": true
49 }
50 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 40XX

responseMessage Required {string} See response chart

transportationProvider Required {element} Container element

transportationProvider Street Required {shortstring} Transportation Provider (TP)

street

transportationProvider Streeet2 Optional {shortstring} TP address line 2

transportationProvider City Required {shortstring} TP city

8
transportationProvider State Required {shortstring} TP State

transportationProvider Zip Required {zipcode} TP zip code

transportationProvider Required {shortstring} TP owner First name

Owner_First_Name

transportationProvider Required {shortstring} TP owner Last name

Owner_Last_Name

transportationProvider Required {phone} TP owner phone number

Owner_Phone

transportationProvider Required {email} TP owner email address

Owner_Email

transportationProvider Required {shortstring} TP operations manager first

Operations_Manager_First_Nam name
e

transportationProvider Required {shortstring} TP operations manager Last

Operations_Manager_Last_Nam name
e

transportationProvider Required {phone} TP operations manager phone

Operations_Manager_Phone number

transportationProvider Required {email} TP operations manager email

Operations_Manager_Email

transportationProvider optional {shortstring} TP contact 1 first name

Contact_1_First_Name

transportationProvider Optional {shortstring} TP contact 1 last name

Contact_1_Last_Name

transportationProvider Optional {phone} TP contact 1 phone number

Contact_1_Phone

transportationProvider Optional {email} TP contact 1 email

Contact_1_Email

transportationProvider optional {shortstring} TP contact 2 first name

Contact_2_First_Name

transportationProvider Optional {shortstring} TP contact 2 last name

Contact_2_Last_Name

transportationProvider Optional {phone} TP contact 2 phone number

Contact_2_Phone

transportationProvider Optional {email} TP contact 2 email

Contact_2_Email

transportationProvider Required {int} TP Mailing address Id

mailing_address_detail_id

transportationProvider Required {int} TP routing company id

Routing_Company_ID

9
transportationProvider Required {int} TP billing company id
Billing_Company_ID

physicalAddress Required {element} Container element

physicalAddress Required {int} Physical Address address detail

address_detail_id id

physicalAddress address Required {shortstring} Physical Address street address

physicalAddress secondary Required {shortstring} Physical Address secondary

address (e.g: Suite#)

physicalAddress city Required {shortstring} Physical Address city

physicalAddress state Required {shortstring} Physical Address state

physicalAddress zip Required {zipcode} Physical Address zip code

mailingAddress {element} Container element

mailingAddress Required {int} Mailing Address address detail id

address_detail_id

mailingAddress address Required {shortstring} Mailing Address street address

mailingAddress secondary Required {shortstring} Mailing Address secondary

address (e.g.: Suite#)

mailingAddress city Required {shortstring} Mailing Address city

mailingAddress state Required {shortstring} Mailing Address state

mailingAddress zip Required {zipcode} Mailing Address zip code

billingCompany Required {element} Container element

billingCompany ID Required {int} Billing Company ID

billingCompany Company_type Required {shortstring} Billing Company company type

(Billing)

billingCompany Company_Name Required {shortstring} Billing Company name

billingCompany Required {shortstring} Billing Company contact first

Contact_First_Name name

billingCompany Required {shortstring} Billing Company contact last

Contact_Last_Name name

billingCompany Email_Address Required {email} Billing Company email address

billingCompany Phone_Number Required {phone} Billing Company phone number

billingCompany Website_URL Required {shortstring} Billing Company website url

routingCompany Required {element} Container element

routingCompany ID Required {int} Routing Company

routingCompany Company_type Required {shortstring} Routing Company type (Routing)

10
routingCompany Required {shortstring} Routing Company company
Company_Name name

routingCompany Required {shortstring} Routing Company first name

Contact_First_Name

routingCompany Required {shortstring} Routing Company last name

Contact_Last_Name

routingCompany Email_Address Required {email} Routing Company email address

routingCompany Phone_Number Required {phone} Routing Company phone number

routingCompany Website_URL Required {shortstring} Routing Company website url

Response Examples

XML

1 <?xml version="1.0" encoding="utf-8" ?>

2 <TPResponse mode="Testing">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <updateProviderInfo version="1">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 <transportationProvider>
9 <Street>1111 NJ-73</Street>
10 <Street2>suite#138</Street2>
11 <City>Mount Laurel Townshi</City>
12 <State>NJ</State>
13 <Zip>08054</Zip>
14 <Owner_First_Name>Mike</Owner_First_Name>
15 <Owner_Last_Name>Collins</Owner_Last_Name>
16 <Owner_Phone>650-279-1266</Owner_Phone>
17 <Owner_Email>[email protected]</Owner_Email>
18 <Operations_Manager_First_Name>operationsTest</Operations_Manager_First_Name>
19 <Operations_Manager_Last_Name>managerTest</Operations_Manager_Last_Name>
20 <Operations_Manager_Phone>650-279-1288</Operations_Manager_Phone>
21 <Operations_Manager_Email>[email protected]</Operations_Manager_Email>
22 <Contact_1_First_Name>testContact1</Contact_1_First_Name>
23 <Contact_1_Last_Name>testersonContact1</Contact_1_Last_Name>
24 <Contact_1_Phone>650-279-6577</Contact_1_Phone>
25 <Contact_1_Email>[email protected]</Contact_1_Email>
26 <Contact_2_First_Name>testContact2</Contact_2_First_Name>
27 <Contact_2_Last_Name>testersonContact2</Contact_2_Last_Name>
28 <Contact_2_Phone>650-279-6588</Contact_2_Phone>
29 <Contact_2_Email>[email protected]</Contact_2_Email>
30 <mailing_address_detail_id>24440363</mailing_address_detail_id>
31 <Routing_Company_ID>1</Routing_Company_ID>
32 <Billing_Company_ID>2</Billing_Company_ID>
33 </transportationProvider>
34 <physicalAddress>
35 <address_detail_id>24440362</address_detail_id>
36 <address>1111 NJ-73</address>
37 <secondary>suite#138</secondary>
38 <city>Mount Laurel Township</city>
39 <state>NJ</state>
40 <zip>08054</zip>

11
41 </physicalAddress>
42 <mailingAddress>
43 <address_detail_id>24440363</address_detail_id>
44 <address>1942 Ford Rd</address>
45 <secondary></secondary>
46 <city>Bristol</city>
47 <state>PA</state>
48 <zip>19007</zip>
49 </mailingAddress>
50 <billingCompany>
51 <ID>2</ID>
52 <Company_type>Billing</Company_type>
53 <Company_Name>Transit Partners</Company_Name>
54 <Contact_First_Name>Ronald</Contact_First_Name>
55 <Contact_Last_Name>Molloy</Contact_Last_Name>
56 <Email_Address>[email protected]</Email_Address>
57 <Phone_Number>914-506-4170</Phone_Number>
58 <Website_URL>www.CompanyWebsite.com</Website_URL>
59 </billingCompany>
60 <routingCompany>
61 <ID>1</ID>
62 <Company_type>Routing</Company_type>
63 <Company_Name>Transit Partners</Company_Name>
64 <Contact_First_Name>Ronald</Contact_First_Name>
65 <Contact_Last_Name>Molloy</Contact_Last_Name>
66 <Email_Address>[email protected]</Email_Address>
67 <Phone_Number>914-506-4170</Phone_Number>
68 <Website_URL>www.CompanyWebsite.com</Website_URL>
69 </routingCompany>
70 </updateProviderInfo>
71 </TPResponse>

JSON

1 {
2 "TPResponse": {
3 "mode": "Testing",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "updateProviderInfo": {
7 "version": "1",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "transportationProvider": {
11 "Street": "1111 NJ-73",
12 "Street2": "suite#138",
13 "City": "Mount Laurel Townshi",
14 "State": "NJ",
15 "Zip": "08054",
16 "Owner_First_Name": "Mike",
17 "Owner_Last_Name": "Collins",
18 "Owner_Phone": "650-279-1266",
19 "Owner_Email": "[email protected]",
20 "Operations_Manager_First_Name": "operationsTest",
21 "Operations_Manager_Last_Name": "managerTest",
22 "Operations_Manager_Phone": "650-279-1288",
23 "Operations_Manager_Email": "[email protected]",
24 "Contact_1_First_Name": "testContact1",

12
 25 "Contact_1_Last_Name": "testersonContact1",
26 "Contact_1_Phone": "650-279-6577",
27 "Contact_1_Email": "[email protected]",
28 "Contact_2_First_Name": "testContact2",
29 "Contact_2_Last_Name": "testersonContact2",
30 "Contact_2_Phone": "650-279-6588",
31 "Contact_2_Email": "[email protected]",
32 "mailing_address_detail_id": "24440359",
33 "Routing_Company_ID": "1",
34 "Billing_Company_ID": "2"
35 },
36 "physicalAddress": {
37 "address_detail_id": "24440358",
38 "address": "1111 NJ-73",
39 "secondary": "suite#138",
40 "city": "Mount Laurel Township",
41 "state": "NJ",
42 "zip": "08054"
43 },
44 "mailingAddress": {
45 "address_detail_id": "24440359",
46 "address": "1942 Ford Rd",
47 "secondary": "",
48 "city": "Bristol",
49 "state": "PA",
50 "zip": "19007"
51 },
52 "billingCompany": {
53 "ID": "2",
54 "Company_type": "Billing",
55 "Company_Name": "Transit Partners",
56 "Contact_First_Name": "Ronald",
57 "Contact_Last_Name": "Molloy",
58 "Email_Address": "[email protected]",
59 "Phone_Number": "914-506-4170",
60 "Website_URL": "www.CompanyWebsite.com"
61 },
62 "routingCompany": {
63 "ID": "1",
64 "Company_type": "Routing",
65 "Company_Name": "Transit Partners",
66 "Contact_First_Name": "Ronald",
67 "Contact_Last_Name": "Molloy",
68 "Email_Address": "[email protected]",
69 "Phone_Number": "914-506-4170",
70 "Website_URL": "www.CompanyWebsite.com"
71 }
72 }
73 }
74 }

UpdateProviderInfo | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

13
MyTransportationProviderInfo

MyTransportationProviderInfo | Request Elements | Request Examples | JSON | Response Elements | Response Examples | JSON

MyTransportationProviderInfo v1

Returns details for each Transportation Provider’s profiles in the various counties they do business.

This includes county 99 which is a “unified” profile and the primary profile now.
Earlier versions of the system used individual county profiles, but now the unified county 99 profile is used for all transactions and
tracking.
Every company has a county 99 profile and companies which have been added more recently do not have any other counties listed.

Request Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

sessionIdentifier Required {sessionId} Session Id

Request Examples

XML
6015 = Invalid Request

Request must use JSON

JSON 1 {
2 "sessionIdentifier": "{{sessionIdentifier}}",
3 "call": "myTransportationProviderInfo",
4 "version": 1
5 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

sessionIdentifier Required {sessionId} Session Id

id Required {int} User Id

providerID Required {int} Provider Id

medicaidCountyNumber Required {int} Medicaid county number 99 is

“unified”

medicaidCounty Required {string} Medicaid county name; blank if

“unified”

primary Required {boolean} Primary county indicator

14
companyName Required {string} Company name

contactFirstName Required {string} Contact first name

contactLastName Required {string} Contact last name

email Required {email} Contact email

tripTypes Required {string} Pipe delimited Trip type names

addressDetailId Required {int} Address detail id

address Required {string} Street address

secondary Required {string} Secondary street address

detail Required {string} Address additional detail

city Required {string} Address city

state Required {string} Address state

zip Required {string} Address zip

county Required {string} Address county

canAccessDriverApp Required {bool} Indicates if there is access to the

driver app

Trans_Provider_Service_Areas_I Required {int} Service Areas Id

d

Label Required {string} Display label

Dispatch_Contact_First_Name Optional {string} Dispatcher’s first name

Dispatch_Contact_Last_Name Optional {string} Dispatcher’s last name

Dispatch_Contact_Phone Optional {string} Dispatcher’s phone number

Dispatch_Contact_Phone_Ext Optional {string} Dispatcher’s phone number

extension

Dispatch_Contact_Email Optional {string} Dispatcher’s email address

Response Examples

XML
6014 = Invalid Accept

Must use JSON

JSON 1 {
2 "MTMResponse": {
3 "mode": "Testing",
4 "callStatus": 1000,
5 "callMessage": "Success.",
6 "myTransportationProviderInfo": {
7 "version": 1,
8 "responseStatus": 1000,
9 "responseMessage": "Success.",
10 "myTransportationProviderInfoResults": [

15
 11 {
12 "id": 52034,
13 "providerID": "54648",
14 "medicaidCountyNumber": "99",
15 "medicaidCounty": "",
16 "primary": false,
17 "companyName": "Sunshine Cab Company",
18 "contactFirstName": "Jim",
19 "contactLastName": "Smith",
20 "email": "[email protected]",
21 "tripTypes": "Medicaid| Title XX",
22 "addressDetailId": "123456",
23 "address": "13030 Main St",
24 "secondary": "Ste 801",
25 "detail": "",
26 "city": "Flushing",
27 "state": "NY",
28 "zip": "11354",
29 "county": "Queens",
30 "canAccessDriverApp": false,
31 "Trans_Provider_Service_Areas_Id": "34",
32 "Label": "Default",
33 "Dispatch_Contact_First_Name": "Louie",
34 "Dispatch_Contact_Last_Name": "Smith",
35 "Dispatch_Contact_Phone": "3151231234",
36 "Dispatch_Contact_Phone_Ext": "",
37 "Dispatch_Contact_Email": "[email protected]"
38 },
39 …
40 ]
41 }
42 }
43 }

MyTransportationProviderInfo | Request Elements | Request Examples | JSON | Response Elements | Response Examples | JSON

16
TransportationProviderProfile

TransportationProviderProfile | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML |
JSON

TransportationProviderProfile v1

Getter endpoint which provides company information for a specific profileId .

profileId is linked to a specific county or county 99 which would be the “unified” profile.

Returns contact and address information similar to MyTransportationProviderInfo, but also returns much more.
For example: schedule info, selected billing/routing company, various credentialing fields, services, zip codes serviced, drivers, vehicles,
and more.

Request Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

sessionIdentifier Required {sessionId} Session Id

profileID Required {int} TP's Profile Id (from MTM

myTransportationProviderInfo)

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <transportationProviderProfile version="1">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <profileID>{{profileId}}</profileID>
6 </transportationProviderProfile>
7 </TPRequest>

JSON 1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "transportationProviderProfile",
5 "version": "1",
6 "profileID": "{{profileID}}"
7 }
8 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responsestatus Required {int} 1000, 40XX

responseMessage Required {string} See response chart

17
status Required {bool} Status

Company_Name Required {string} Company name

FAX Required {phone} Fax number

Owner_First_Name Required {string} Owner first name

Owner_Last_Name Required {string} Owner last name

Owner_Phone Required {phone} Owner phone

Owner_Email Required {email} Owner email

Operations_Manager_First_Nam Required {string} Operations Manager first name

e

Operations_Manager_Last_Nam Required {string} Operations Manager last name

e

Operations_Manager_Phone Required {phone} Operations Manager phone

Operations_Manager_Email Required {email} Operations Manager email

Dispatch_First_Name Required {string} Dispatch first name

Dispatch_Last_Name Required {string} Dispatch last name

Dispatch_Phone Required {phone} Dispatch phone

Dispatch_Email Required {email} Dispatch email

Contact_1_First_Name Optional {string} Contact_1 first name

Contact_1_Last_Name Optional {string} Contact_1 last name

Contact_1_Phone Optional {phone} Contact_1 phone

Contact_1_Email Optional {email} Contact_1 email

Contact_2_First_Name Optional {string} Contact_2 first name

Contact_2_Last_Name Optional {string} Contact_2 last name

Contact_2_Phone Optional {phone} Contact_2 phone

Contact_2_Email Optional {email} Contact_2 email

Provider_ID Required {int} Transportation provider id

Contact_Method Required {string} Contact method

Business_Hours Required {timestamp} Business hours in local time

Tax_ID Required {string} Tax id

Use_Schedule Required {bool} Use schedule (bool)

Monday_Start_Time Required {timestamp} Start time in local time

Monday_End_Time Required {timestamp} End time in local time

Tuesday_Start_Time Required {timestamp} Start time in local time

18
Tuesday_End_Time Required {timestamp} End time in local time

Wednesday_Start_Time Required {timestamp} Start time in local time

Wednesday_End_Time Required {timestamp} End time in local time

Thursday_Start_Time Required {timestamp} Start time in local time

Thursday_End_Time Required {timestamp} End time in local time

Friday_Start_Time Required {timestamp} Start time in local time

Friday_End_Time Required {timestamp} End time in local time

Saturday_Start_Time Required {timestamp} Start time in local time

Saturday_End_Time Required {timestamp} End time in local time

Sunday_Start_Time Required {timestamp} Start time in local time

Sundauy_End_Time Required {timestamp} End time in local time

Monday_Set_Hours_Available Required {bool} Set hours available (bool)

Tuesday_Set_Hours_Available Required {bool} Set hours available (bool)

Wednesday_Set_Hours_Availabl Required {bool} Set hours available (bool)

e

Thursday_Set_Hours_Available Required {bool} Set hours available (bool)

Friday_Set_Hours_Available Required {bool} Set hours available (bool)

Saturday_Set_Hours_Available Required {bool} Set hours available (bool)

Sunday_Set_Hours_Available Required {bool} Set hours available (bool)

Display_On_Public_Site Required {bool} Display on public site (bool)

Local_Payment Required {bool} Local payment ok (bool)

Include_In_Rotation Required {bool} Include in rotation (bool)

address_detail_id Required {int} Address detail id

SameDayCall Required {bool} Same day call ok (bool)

NextDayCall Required {bool} Next day call ok (bool)

mailing_address_detail_id Required {int} Mailing address detail id

Is_RideHail Required {bool} Ride hail ok (bool)

Use_Daily_Ride_Capacity Required {bool} Use daily ride capacity (bool)

Monday_Daily_Ride_Capacity Required {int} Daily ride capacity

Tuesday_Daily_Ride_Capacity Required {int} Daily ride capacity

Wednesday_Daily_Ride_Capacit Required {int} Daily ride capacity

y

Thursday_Daily_Ride_Capacity Required {int} Daily ride capacity

19
Friday_Daily_Ride_Capacity Required {int} Daily ride capacity

Saturday_Daily_Ride_Capacity Required {int} Daily ride capacity

Sunday_Daily_Ride_Capacity Required {int} Daily ride capacity

Routing_Company_ID Required {int} Routing company id

Billing_Company_ID Required {int} Billing company id

Comments Required {string} Comments

IsDOHApprovalLetterActive Required {bool} Is there an active DOH approval

letter

IsEMedNyRegistrationActive Required {bool} Is EMED NY registration active

IsTLCActive Required {bool} Is TLC active

IsGPSCapabilitiesActive Required {bool} Are GPS capabilities active

IsMASContractAgreementsCom Required {bool} Are MAS contract agreements

pleted completed

IsDrugFreeWorkplace Required {bool} Is it a drug free workplace

IsMASOrientationComplete Required {bool} Is MAS orientation complete

IsCompanyExclusionCheckStatu Required {bool} Is there an active company

sActive exclusion

CompanyExclusionDate Required {date} company exclusion date

IsOwnerExclusionCheckStatusA Required {bool} Is there an active owner

ctive exclusion

OwnerExclusionCheckDate Required {date} owner exclusion date

IsOperationsManagerExclusionC Required {bool} Is there an active manager

heckStatusActive exclusion

OperationsManagerExclusionCh Required {date} manager exclusion date

eckDate

IsContact1ExclusionCheckStatus Required {bool} Is there an active contact 1

Active exclusion

Contact1ExclusionCheckDate Required {date} contact exclusion date

IsContact2ExclusionCheckStatus Required {bool} Is there an active contact 2

Active exclusion

Contact2ExclusionCheckDate Required {date} contact exclusion date

NPINumber Required {string} NPI Number

Unavailable_Dates Required {date} Unavailable date

Service_Codes ID Required {int} Service id

Service_Codes Status Required {bool} Service code status

20
Service_Codes Trans_Type_ID Required {int} Transportation type id

Service_Codes Service Required {string} Service type

Service_Codes Procedure_Code Required {string} Service type procedure code

Service_Codes Required {string} Service type procedure code

Procedure_Code_Mod modifier

Service_Codes Rate Required {decimal} Service rate

Drivers ID Required {int} Driver id

Drivers Status Required {bool} Driver status

Drivers First_Name Required {string} Driver first name

Drivers Last_Name Required {string} Driver last name

Drivers License Required {string} Driver license number

Drivers Expiration Required {date} Driver license expiration

Email_Address Required {string} Driver email address

Birth_Date Required {date} Driver birth date

CTAA_Email_Address Required {string} Driver email address for CTAA

MVR_Check_Date Required {date} MVR check date

MVR_Check_Status Required {bool} MVR check status

Vehicles ID Required {int} Vehicle id

Vehicles Status Required {bool} Vehicle status

Vehicles Vehicle_Type Required {string} Vehicle type

Vehicles Vehicle_Name Required {string} Vehicle name

Vehicles License Required {string} Vehicle license

Vehicles Expiration Required {date} Vehicle expiration date

Vin Required {string} Vehicle identification number

Vehicle_Year Required {int} Vehicle year

Vehicle_Make Required {string} Vehicle make

Vehicle_Model Required {string} Vehicle model

Vehicle_Color Required {string} Vehicle color

Capacity_Taxi_Livery Required {int} Vehicle capacity for taxi/livery

Capacity_Ambulatory Required {int} Vehicle ambulatory capacity

Capacity_Wheelchair Required {int} Vehicle wheelchair capacity

Capacity_Stretcher Required {int} Vehicle stretcher capacity

21
Capacity_BLS Required {int} Vehicle BLS capacity

Capacity_ALS Required {int} Vehicle ALS capacity

DMV_Registration_Status Required {bool} Vehicle

serviceZipCodes zipcode Required {zipcode} Service zipcode

serviceZipCodes county Required {string} Service county

serviceZipCodes Required {int} Address county ID

address_county_id

availableServiceTypes Required {int} Service type ID

serviceTypeId

availableServiceTypes Required {string} Service type name

serviceTypeShortName

serviceCapacities serviceTypeId Required {int} Service type ID

serviceCapacities days day Required {int} Day number (0-6 Sun-Sat)

serviceCapacities days capacity Required {int} Service capacity for this day

serviceCapacities days Required {int} Service maximum capacity for

maximumCapacity this day

serviceAreas serviceAreaId Required {int} Service area ID

serviceAreas label Required {string} Service area label

serviceAreas serviceTypeIds Required {int} Array of service type ids

serviceAreas SA_ID Required {int} Service area ID

serviceAreas Optional {string} Service area dispatch first name

SA_Dispatch_First_Name

serviceAreas Optional {string} Service area dispatch last name

SA_Dispatch_Last_Name

serviceAreas Optional {string} Service area dispatch phone

SA_Dispatch_Phone number

serviceAreas Optional {string} Service area dispatch phone

SA_Dispatch_Phone_Ext extension

serviceAreas Optional {string} Service area dispatch email

SA_Dispatch_Email

serviceAreas zipcodes Required {zipcode} Array of zip codes included in

this service area

serviceAreas availability day Required {int} Day number (0-6 Sun-Sat)

serviceAreas availability open Required {time} 24 hour time open for this
service area day (e.g.: 0600 =
6:00 AM)

22
serviceAreas availability closed Required {time} 24 hour time open for this
service area day (e.g.: 0600 =
6:00 AM)

can_toggle_schedule Required {bool} If schedule is optional for TP

ambulanceService Required {bool} Ambulance service provided

isUnifiedInUse Required {bool} TP has activated unified profile

canAccessDriverApp Required {bool} Indicates if there is access to the

driver app

Response Examples

23
XML 1 <?xml version="1.0" encoding="utf-8" ?>
2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <transportationProviderProfile version="1">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 <Status>
9 <![CDATA[1]]>
10 </Status>
11 <Company_Name>
12 <![CDATA[Training Vendor]]>
13 </Company_Name>
14 <FAX></FAX>
15 <Owner_First_Name>
16 <![CDATA[Mike]]>
17 </Owner_First_Name>
18 <Owner_Last_Name>
19 <![CDATA[Collins]]>
20 </Owner_Last_Name>
21 <Owner_Phone>
22 <![CDATA[6502791266]]>
23 </Owner_Phone>
24 <Owner_Email>
25 <![CDATA[[email protected]]]>
26 </Owner_Email>
27 <Operations_Manager_First_Name>
28 <![CDATA[operationsTest]]>
29 </Operations_Manager_First_Name>
30 <Operations_Manager_Last_Name>
31 <![CDATA[managerTest]]>
32 </Operations_Manager_Last_Name>
33 <Operations_Manager_Phone>
34 <![CDATA[6502791288]]>
35 </Operations_Manager_Phone>
36 <Operations_Manager_Email>
37 <![CDATA[[email protected]]]>
38 </Operations_Manager_Email>
39 <Dispatch_First_Name>
40 <![CDATA[Terri]]>
41 </Dispatch_First_Name>
42 <Dispatch_Last_Name>
43 <![CDATA[Collins]]>
44 </Dispatch_Last_Name>
45 <Dispatch_Phone>
46 <![CDATA[6502791277]]>
47 </Dispatch_Phone>
48 <Dispatch_Email>
49 <![CDATA[[email protected]]]>
50 </Dispatch_Email>
51 <Contact_1_First_Name>
52 <![CDATA[testContact1]]>
53 </Contact_1_First_Name>
54 <Contact_1_Last_Name>
55 <![CDATA[testersonContact1]]>
56 </Contact_1_Last_Name>
57 <Contact_1_Phone>
58 <![CDATA[6502796577]]>
59 </Contact_1_Phone>

24
60 <Contact_1_Email>
61 <![CDATA[[email protected]]]>
62 </Contact_1_Email>
63 <Contact_2_First_Name>
64 <![CDATA[testContact2]]>
65 </Contact_2_First_Name>
66 <Contact_2_Last_Name>
67 <![CDATA[testersonContact2]]>
68 </Contact_2_Last_Name>
69 <Contact_2_Phone>
70 <![CDATA[6502796588]]>
71 </Contact_2_Phone>
72 <Contact_2_Email>
73 <![CDATA[[email protected]]]>
74 </Contact_2_Email>
75 <Provider_ID>
76 <![CDATA[TRAINING]]>
77 </Provider_ID>
78 <Contact_Method></Contact_Method>
79 <Business_Hours></Business_Hours>
80 <Tax_ID></Tax_ID>
81 <Use_Schedule>true</Use_Schedule>
82 <Monday_Start_Time>00:00</Monday_Start_Time>
83 <Monday_End_Time>24:00</Monday_End_Time>
84 <Tuesday_Start_Time>00:00</Tuesday_Start_Time>
85 <Tuesday_End_Time>24:00</Tuesday_End_Time>
86 <Wednesday_Start_Time>00:00</Wednesday_Start_Time>
87 <Wednesday_End_Time>24:00</Wednesday_End_Time>
88 <Thursday_Start_Time>00:00</Thursday_Start_Time>
89 <Thursday_End_Time>24:00</Thursday_End_Time>
90 <Friday_Start_Time>00:00</Friday_Start_Time>
91 <Friday_End_Time>24:00</Friday_End_Time>
92 <Saturday_Start_Time>00:00</Saturday_Start_Time>
93 <Saturday_End_Time>24:00</Saturday_End_Time>
94 <Sunday_Start_Time>00:00</Sunday_Start_Time>
95 <Sunday_End_Time>24:00</Sunday_End_Time>
96 <Monday_Set_Hours_Available></Monday_Set_Hours_Available>
97 <Tuesday_Set_Hours_Available></Tuesday_Set_Hours_Available>
98 <Wednesday_Set_Hours_Available></Wednesday_Set_Hours_Available>
99 <Thursday_Set_Hours_Available></Thursday_Set_Hours_Available>
100 <Friday_Set_Hours_Available></Friday_Set_Hours_Available>
101 <Saturday_Set_Hours_Available></Saturday_Set_Hours_Available>
102 <Sunday_Set_Hours_Available></Sunday_Set_Hours_Available>
103 <Display_on_Public_Site>true</Display_on_Public_Site>
104 <Local_Payment>false</Local_Payment>
105 <Include_In_Rotation>false</Include_In_Rotation>
106 <address_detail_id>24440368</address_detail_id>
107 <SameDayCall>true</SameDayCall>
108 <NextDayCall>true</NextDayCall>
109 <mailing_address_detail_id>24440369</mailing_address_detail_id>
110 <Is_RideHail>false</Is_RideHail>
111 <Use_Daily_Ride_Capacity>true</Use_Daily_Ride_Capacity>
112 <Monday_Daily_Ride_Capacity>1000</Monday_Daily_Ride_Capacity>
113 <Tuesday_Daily_Ride_Capacity>1000</Tuesday_Daily_Ride_Capacity>
114 <Wednesday_Daily_Ride_Capacity>50</Wednesday_Daily_Ride_Capacity>
115 <Thursday_Daily_Ride_Capacity>50</Thursday_Daily_Ride_Capacity>
116 <Friday_Daily_Ride_Capacity>50</Friday_Daily_Ride_Capacity>
117 <Saturday_Daily_Ride_Capacity>40</Saturday_Daily_Ride_Capacity>
118 <Sunday_Daily_Ride_Capacity>1000</Sunday_Daily_Ride_Capacity>
119 <Routing_Company_ID>1</Routing_Company_ID>

25
120 <Billing_Company_ID>2</Billing_Company_ID>
121 <Comments></Comments>
122 <IsDOHApprovalLetterActive>false</IsDOHApprovalLetterActive>
123 <IsEMedNyRegistrationActive>false</IsEMedNyRegistrationActive>
124 <IsTLCActive>true</IsTLCActive>
125 <IsGPSCapabilitiesActive>true</IsGPSCapabilitiesActive>
126 <IsMASContractAgreementsCompleted>true</IsMASContractAgreementsCompleted>
127 <IsDrugFreeWorkplace>true</IsDrugFreeWorkplace>
128 <IsMASOrientationComplete>true</IsMASOrientationComplete>
129 <IsCompanyExclusionCheckStatusActive>false</IsCompanyExclusionCheckStatusActive>
130 <CompanyExclusionDate></CompanyExclusionDate>
131 <IsOwnerExclusionCheckStatusActive>false></IsOwnerExclusionCheckStatusActive>
132 <OwnerExclusionCheckDate></OwnerExclusionCheckDate>
133 <IsOperationsManagerExclusionCheckStatusActive>false</IsOperationsManagerExclusionCheckStatusAct
134 <OperationsManagerExclusionCheckDate></OperationsManagerExclusionCheckDate>
135 <IsContact1ExclusionCheckStatusActive>false</IsContact1ExclusionCheckStatusActive>
136 <Contact1ExclusionCheckDate></Contact1ExclusionCheckDate>
137 <IsContact2ExclusionCheckStatusActive>false</IsContact2ExclusionCheckStatusActive>
138 <Contact2ExclusionCheckDate></Contact2ExclusionCheckDate>
139 <NPINumber>1234567891</NPINumber>
140 <Unavailable_Dates>
141 <value>06/10/2019</value>
142 <value>09/09/2021</value>
143 <value>01/01/2022</value>
144 ...
145 </Unavailable_Dates>
146 <Service_Codes>
147 <service>
148 <ID>836255</ID>
149 <Status>1</Status>
150 <Trans_Type_ID></Trans_Type_ID>
151 <Service>Mileage-Ambulette Cattaraugus</Service>
152 <Procedure_Code>S0209</Procedure_Code>
153 <Procedure_Code_Mod></Procedure_Code_Mod>
154 <Rate>2.06</Rate>
155 </service>
156 ...
157 </Service_Codes>
158 <Drivers>
159 <driver>
160 <ID>1648973</ID>
161 <Status>1</Status>
162 <First_Name>chuck</First_Name>
163 <Last_Name>blue</Last_Name>
164 <License>123455677</License>
165 <Expiration>11/10/2021</Expiration>
166 <Email_Address>
167 <![CDATA[[email protected]]]>
168 </Email_Address>
169 <Birth_Date>10/20/1962</Birth_Date>
170 <CTAA_Email_Address>
171 <![CDATA[[email protected]]]>
172 </CTAA_Email_Address>
173 <MVR_Check_Date></MVR_Check_Date>
174 <MVR_Check_Status>0</MVR_Check_Status>
175 </driver>
176 ...
177 </Drivers>
178 <Vehicles>
179 <vehicle>

26
180 <ID>1418507</ID>
181 <Status>0</Status>
182 <Vehicle_Type>betsy</Vehicle_Type>
183 <Vehicle_Name>Livery</Vehicle_Name>
184 <License>abc123</License>
185 <Expiration>10/31/2022</Expiration>
186 <Vin>1WXYZ31L58DB07T87</Vin>
187 <Vehicle_Year>2008</Vehicle_Year>
188 <Vehicle_Make>FORD</Vehicle_Make>
189 <Vehicle_Model>E-350</Vehicle_Model>
190 <Vehicle_Color>gray</Vehicle_Color>
191 <Capacity_Taxi_Livery>12</Capacity_Taxi_Livery>
192 <Capacity_Ambulatory>0</Capacity_Ambulatory>
193 <Capacity_Wheelchair>0</Capacity_Wheelchair>
194 <Capacity_Stretcher>0</Capacity_Stretcher>
195 <Capacity_BLS>0</Capacity_BLS>
196 <Capacity_ALS>0</Capacity_ALS>
197 <DMV_Registration_Status>1</DMV_Registration_Status>
198 </vehicle>
199 ...
200 </Vehicles>
201 <serviceZipcodes>
202 <zipCounty>
203 <zipcode>10001</zipcode>
204 <county>New York</county>
205 <address_county_id>31</address_county_id>
206 </zipCounty>
207 ...
208 </serviceZipcodes>
209 <availableServiceTypes size="6">
210 <availableServiceType index="1">
211 <serviceTypeId>114606</serviceTypeId>
212 <serviceTypeShortName>Bus-Roster</serviceTypeShortName>
213 </availableServiceType>
214 <availableServiceType index="2">
215 <serviceTypeId>108666</serviceTypeId>
216 <serviceTypeShortName>Taxi/Livery</serviceTypeShortName>
217 </availableServiceType>
218 <availableServiceType index="3">
219 <serviceTypeId>108662</serviceTypeId>
220 <serviceTypeShortName>Ambulatory</serviceTypeShortName>
221 </availableServiceType>
222 <availableServiceType index="4">
223 <serviceTypeId>108667</serviceTypeId>
224 <serviceTypeShortName>Stretcher</serviceTypeShortName>
225 </availableServiceType>
226 <availableServiceType index="5">
227 <serviceTypeId>108661</serviceTypeId>
228 <serviceTypeShortName>Ambulance-BLS</serviceTypeShortName>
229 </availableServiceType>
230 <availableServiceType index="6">
231 <serviceTypeId>108660</serviceTypeId>
232 <serviceTypeShortName>Ambulance-ALS</serviceTypeShortName>
233 </availableServiceType>
234 </availableServiceTypes>
235 <serviceCapacities>
236 <serviceType id="108660">
237 <capacity maximumCapacity="99999" day="0">1</capacity>
238 <capacity maximumCapacity="99999" day="1">2</capacity>
239 <capacity maximumCapacity="99999" day="2">3</capacity>

27
 240 <capacity maximumCapacity="99999" day="3">4</capacity>
241 <capacity maximumCapacity="99999" day="4">5</capacity>
242 <capacity maximumCapacity="99999" day="5">6</capacity>
243 <capacity maximumCapacity="99999" day="6">7</capacity>
244 </serviceType>
245 ...
246 </serviceCapacities>
247 <serviceAreas count="1">
248 <serviceAreaId>1932</serviceAreaId>
249 <label>Test South</label>
250 <serviceTypeIds count="1">
251 <id>108667</id>
252 </serviceTypeIds>
253 <zipcodes count="120">
254 <zip>12041</zip>
255 <zip>12045</zip>
256 <zip>12046</zip>
257 <zip>12047</zip>
258 ...
259 </zipcodes>
260 <availability count="7">
261 <day>0</day>
262 <open>0000</open>
263 <closed>2400</closed>
264 <day>1</day>
265 <open>0000</open>
266 <closed>2400</closed>
267 <day>2</day>
268 <open>0000</open>
269 <closed>2400</closed>
270 <day>3</day>
271 <open>0000</open>
272 <closed>2400</closed>
273 <day>4</day>
274 <open>0000</open>
275 <closed>2400</closed>
276 <day>5</day>
277 <open>0000</open>
278 <closed>2400</closed>
279 <day>6</day>
280 <open>0000</open>
281 <closed>2400</closed>
282 </availability>
283 </serviceAreas>
284 <can_toggle_schedule>true</can_toggle_schedule>
285 <ambulanceService>true</ambulanceService>
286 <isUnifiedInUse>true</isUnifiedInUse>
287 </transportationProviderProfile>
288 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "transportationProviderProfile": {
7 "version": "1",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",

28
10 "Status": "1",
11 "Company_Name": "Training Vendor",
12 "FAX": "",
13 "Owner_First_Name": "Mike",
14 "Owner_Last_Name": "Collins",
15 "Owner_Phone": "6502791266",
16 "Owner_Email": "[email protected]",
17 "Operations_Manager_First_Name": "operationsTest",
18 "Operations_Manager_Last_Name": "managerTest",
19 "Operations_Manager_Phone": "6502791288",
20 "Operations_Manager_Email": "[email protected]",
21 "Dispatch_First_Name": "Terri",
22 "Dispatch_Last_Name": "Collins",
23 "Dispatch_Phone": "6502791277",
24 "Dispatch_Email": "[email protected]",
25 "Contact_1_First_Name": "testContact1",
26 "Contact_1_Last_Name": "testersonContact1",
27 "Contact_1_Phone": "6502796577",
28 "Contact_1_Email": "[email protected]",
29 "Contact_2_First_Name": "testContact2",
30 "Contact_2_Last_Name": "testersonContact2",
31 "Contact_2_Phone": "6502796588",
32 "Contact_2_Email": "[email protected]",
33 "Provider_ID": "TRAINING",
34 "Contact_Method": "",
35 "Business_Hours": "",
36 "Tax_ID": "",
37 "Use_Schedule": true,
38 "Monday_Start_Time": "00:00",
39 "Monday_End_Time": "24:00",
40 "Tuesday_Start_Time": "00:00",
41 "Tuesday_End_Time": "24:00",
42 "Wednesday_Start_Time": "00:00",
43 "Wednesday_End_Time": "24:00",
44 "Thursday_Start_Time": "00:00",
45 "Thursday_End_Time": "24:00",
46 "Friday_Start_Time": "00:00",
47 "Friday_End_Time": "24:00",
48 "Saturday_Start_Time": "00:00",
49 "Saturday_End_Time": "24:00",
50 "Sunday_Start_Time": "00:00",
51 "Sunday_End_Time": "24:00",
52 "Monday_Set_Hours_Available": "",
53 "Tuesday_Set_Hours_Available": "",
54 "Wednesday_Set_Hours_Available": "",
55 "Thursday_Set_Hours_Available": "",
56 "Friday_Set_Hours_Available": "",
57 "Saturday_Set_Hours_Available": "",
58 "Sunday_Set_Hours_Available": "",
59 "Display_on_Public_Site": true,
60 "Local_Payment": false,
61 "Include_In_Rotation": false,
62 "address_detail_id": "24440368",
63 "SameDayCall": true,
64 "NextDayCall": true,
65 "mailing_address_detail_id": "24440369",
66 "Is_RideHail": false,
67 "Use_Daily_Ride_Capacity": true,
68 "Monday_Daily_Ride_Capacity": "1000",
69 "Tuesday_Daily_Ride_Capacity": "1000",

29
70 "Wednesday_Daily_Ride_Capacity": "50",
71 "Thursday_Daily_Ride_Capacity": "50",
72 "Friday_Daily_Ride_Capacity": "50",
73 "Saturday_Daily_Ride_Capacity": "40",
74 "Sunday_Daily_Ride_Capacity": "1000",
75 "Routing_Company_ID": "1",
76 "Billing_Company_ID": "2",
77 "Comments": "",
78 "IsDOHApprovalLetterActive": false,
79 "IsEMedNyRegistrationActive": false,
80 "IsTLCActive": true,
81 "IsGPSCapabilitiesActive": true,
82 "IsMASContractAgreementsCompleted": true,
83 "IsDrugFreeWorkplace": true,
84 "IsMASOrientationComplete": true,
85 "IsCompanyExclusionCheckStatusActive": false,
86 "CompanyExclusionDate": "",
87 "IsOwnerExclusionCheckStatusActive": false,
88 "OwnerExclusionCheckDate": "",
89 "IsOperationsManagerExclusionCheckStatusActive": false,
90 "OperationsManagerExclusionCheckDate": "",
91 "IsContact1ExclusionCheckStatusActive": false,
92 "Contact1ExclusionCheckDate": "",
93 "IsContact2ExclusionCheckStatusActive": false,
94 "Contact2ExclusionCheckDate": "",
95 "NPINumber": "1234567891",
96 "Unavailable_Dates": [
97 "06/10/2019",
98 "06/11/2019",
99 "06/12/2019",
100 "06/14/2019",
101 "06/24/2021",
102 "07/11/2021",
103 "08/20/2021",
104 "08/21/2021",
105 "12/08/2021",
106 "01/01/2022"
107 ],
108 "Service_Codes": [
109 {
110 "ID": "839079",
111 "Status": "1",
112 "Trans_Type_ID": "108666",
113 "Service": "Taxi-Essex",
114 "Procedure_Code": "A0100",
115 "Procedure_Code_Mod": "",
116 "Rate": "8.82"
117 },
118 ...
119 {
120 "ID": "841748",
121 "Status": "1",
122 "Trans_Type_ID": "108663",
123 "Service": "Wheelchair/MN-Hospital Discharge IB",
124 "Procedure_Code": "A0130",
125 "Procedure_Code_Mod": "TG",
126 "Rate": "45.00"
127 }
128 ],
129 "Drivers": [

30
130 {
131 "ID": "1648973",
132 "Status": "1",
133 "First_Name": "chuck",
134 "Last_Name": "blue",
135 "License": "123455677",
136 "Expiration": "11/10/2021",
137 "Email_Address": "[email protected]",
138 "Birth_Date": "10/20/1962",
139 "CTAA_Email_Address": "[email protected]",
140 "MVR_Check_Date": "",
141 "MVR_Check_Status": "0"
142 },
143 ...
144 {
145 "ID": "1785166",
146 "Status": "1",
147 "First_Name": "Fred",
148 "Last_Name": "Burghardt",
149 "License": "580082674",
150 "Expiration": "10/16/2025",
151 "Email_Address": "[email protected]",
152 "Birth_Date": "10/20/1962",
153 "CTAA_Email_Address": "[email protected]",
154 "MVR_Check_Date": "",
155 "MVR_Check_Status": "0"
156 }
157 ],
158 "Vehicles": [
159 {
160 "ID": "1418507",
161 "Status": "0",
162 "Vehicle_Type": "betsy",
163 "Vehicle_Name": "Livery",
164 "License": "abc123",
165 "Expiration": "10/31/2022",
166 "Vin": "1ABCD23E58DB07T56",
167 "Vehicle_Year": "2008",
168 "Vehicle_Make": "FORD",
169 "Vehicle_Model": "E-350",
170 "Vehicle_Color": "blue",
171 "Capacity_Taxi_Livery": "12",
172 "Capacity_Ambulatory": "0",
173 "Capacity_Wheelchair": "0",
174 "Capacity_Stretcher": "0",
175 "Capacity_BLS": "0",
176 "Capacity_ALS": "0",
177 "DMV_Registration_Status": "1"
178 },
179 ...
180 {
181 "ID": "1420507",
182 "Status": "1",
183 "Vehicle_Type": "Trainer Van",
184 "Vehicle_Name": "Livery",
185 "License": "TestVeh",
186 "Expiration": "10/17/2021",
187 "Vin": "1WXYZ31L58DB07T97",
188 "Vehicle_Year": "2018",
189 "Vehicle_Make": "FORD",

31
190 "Vehicle_Model": "E-350",
191 "Vehicle_Color": "Gray",
192 "Capacity_Taxi_Livery": "12",
193 "Capacity_Ambulatory": "0",
194 "Capacity_Wheelchair": "0",
195 "Capacity_Stretcher": "0",
196 "Capacity_BLS": "0",
197 "Capacity_ALS": "0",
198 "DMV_Registration_Status": "1"
199 }
200 ],
201 "serviceZipcodes": [
202 {
203 "zipcode": "10001",
204 "county": "New York",
205 "address_county_id": "31"
206 },
207 ...
208 {
209 "zipcode": "14905",
210 "county": "Chemung",
211 "address_county_id": "8"
212 }
213 ],
214 "availableServiceTypes": [
215 {
216 "serviceTypeId": "114606",
217 "serviceTypeShortName": "Bus-Roster"
218 },
219 {
220 "serviceTypeId": "108666",
221 "serviceTypeShortName": "Taxi/Livery"
222 },
223 {
224 "serviceTypeId": "108662",
225 "serviceTypeShortName": "Ambulatory"
226 },
227 {
228 "serviceTypeId": "108667",
229 "serviceTypeShortName": "Stretcher"
230 },
231 {
232 "serviceTypeId": "108661",
233 "serviceTypeShortName": "Ambulance-BLS"
234 },
235 {
236 "serviceTypeId": "108660",
237 "serviceTypeShortName": "Ambulance-ALS"
238 }
239 ],
240 "serviceCapacities": [
241 {
242 "serviceTypeId": "108660",
243 "days": [
244 {
245 "day": "0",
246 "capacity": "1",
247 "maximumCapacity": "99999"
248 },
249 {

32
 250 "day": "1",
251 "capacity": "2",
252 "maximumCapacity": "99999"
253 },
254 {
255 "day": "2",
256 "capacity": "3",
257 "maximumCapacity": "99999"
258 },
259 {
260 "day": "3",
261 "capacity": "4",
262 "maximumCapacity": "99999"
263 },
264 {
265 "day": "4",
266 "capacity": "5",
267 "maximumCapacity": "99999"
268 },
269 {
270 "day": "5",
271 "capacity": "6",
272 "maximumCapacity": "99999"
273 },
274 {
275 "day": "6",
276 "capacity": "7",
277 "maximumCapacity": "99999"
278 }
279 ]
280 },
281 ...
282 ],
283 "serviceAreas": [
284 {
285 "serviceAreaId": "1932",
286 "label": "Test South",
287 "SA_ID": "3138",
288 "SA_Dispatch_First_Name": "Louie",
289 "SA_Dispatch_Last_Name": "De Palma",
290 "SA_Dispatch_Phone": "1231231234",
291 "SA_Dispatch_Phone_Ext": "4321",
292 "SA_Dispatch_Email": "[email protected]",
293 "serviceTypeIds": [
294 "108667"
295 ],
296 "zipcodes": [
297 "12041",
298 "12045",
299 "12046",
300 "14895",
301 "14897"
302 ],
TransportationProviderProfile
303 | Request Elements
"availability": [ | Request Examples | XML | JSON | Response Elements | Response Examples | XML |
JSON 304 {
305 "day": "0",
306 "open": "0000",
307 "closed": "2400"
308 },
309 {

33
310 "day": "1",
311 "open": "0000",
312 "closed": "2400"
313 },
314 {
315 "day": "2",
316 "open": "0000",
317 "closed": "2400"
318 },
319 {
320 "day": "3",
321 "open": "0000",
322 "closed": "2400"
323 },
324 {
325 "day": "4",
326 "open": "0000",
327 "closed": "2400"
328 },
329 {
330 "day": "5",
331 "open": "0000",
332 "closed": "2400"
333 },
334 {
335 "day": "6",
336 "open": "0000",
337 "closed": "2400"
338 }
339 ]
340 },
341 ...
342 ],
343 "can_toggle_schedule": true,
344 "ambulanceService": true,
345 "isUnifiedInUse": true,
346 "canAccessDriverApp": true
347 }
348 }
349 }

34
Vehicle

Vehicle APIs
The collection of Vehicle APIs, includes getter and setter endpoints for managing company vehicles.

API List

ListVehicles
VehicleUpdate
FindVehicleByVIN

35
ListVehicles

ListVehicles | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

ListVehicles v1

{replace this text with Descriptive Narrative of the API}

Request Elements Required or Optional Type Definition

Session Identifier Required {sessionId} Session Identifier

allVehicles Optional {boolean} true/false show all vehicles

Request Examples

XML 1 <TPRequest>
2 <listVehicles>
3 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
4 </listVehicles>
5 </TPRequest>

JSON 1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "listVehicles",
5 "version":1
6 }
7 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 3060

responseMessage Required {shortstring} See response chart

vehicles Required {element} Element with (int) count attribute

vehicle Required {element} Element with (int) id attribute

Status Required {int} Vehicle Status

Vehicle Type Required {string} Vehicle Type

License Required {string} Vehicle license number

Expiration Required {datetime} Vehicle license expiration

Vehicle Name Required {shortstring} Vehicle name

36
MedicaidCountyNumber Required {int} Medicaid county number

Response Examples

XML 1 <?xml version="1.0" encoding="utf-8" ?>

2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage><![CDATA[Success.]]></callMessage>
5 <listVehicles version="1">
6 <responseStatus>1000</responseStatus>
7 <responseMessage><![CDATA[Success.]]></responseMessage>
8 <vehicles count="61">
9 <vehicle id="1688169">
10 <Status>1</Status>
11 <Vehicle_Type><![CDATA[Taxi]]></Vehicle_Type>
12 <License><![CDATA[PERF 2234]]></License>
13 <Expiration><![CDATA[01/01/2033 00:00:00]]></Expiration>
14 <Vehicle_Name><![CDATA[PerfectoTestCar2]]></Vehicle_Name>
15 <MedicaidCountyNumber><![CDATA[99]]></MedicaidCountyNumber>
16 </vehicle>
17 ...
18 <vehicle id="1472407">
19 <Status>1</Status>
20 <Vehicle_Type><![CDATA[Ambulance]]></Vehicle_Type>
21 <License><![CDATA[0993824]]></License>
22 <Expiration><![CDATA[06/04/2021 00:00:00]]></Expiration>
23 <Vehicle_Name><![CDATA[run]]></Vehicle_Name>
24 <MedicaidCountyNumber><![CDATA[99]]></MedicaidCountyNumber>
25 </vehicle>
26 </vehicles>
27 </listVehicles>
28 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "listVehicles": {
7 "version": "1",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "vehicles": [
11 {
12 "ID": 1688169,
13 "Vehicle_Name": "PerfectoTestCar2",
14 "Vehicle_Type": "Taxi",
15 "Status": 1,
16 "License": "PERF 2234",
17 "Expiration": "01/01/2033 00:00:00",
18 "MedicaidCountyNumber": "99"
19 },
20 ...
21 {
22 "ID": 1472407,
23 "Vehicle_Name": "run",
24 "Vehicle_Type": "Ambulance",
25 "Status": 1,

37
 26 "License": "0993824",
27 "Expiration": "06/04/2021 00:00:00",
28 "MedicaidCountyNumber": "99"
29 }
30 ]
31 }
32 }
33 }

ListVehicles | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

38
VehicleUpdate

VehicleUpdate | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

VehicleUpdate v4

Updates existing vehicle records OR creates a new vehicle record if it does not already exist.

Will match existing Transportation Provider vehicles by vehicleRegistration and update all instances across various county configurations.
Prior to unification (county 99), vehicles were configured in each Medicaid county that the Transportation Provider services.
Helps to keep vehicle updates synced across multiple counties.
The response contains an array of records because it is possible for the same “vehicle” to be matched in multiple counties.
The ‘registrationId’ is the ‘listVehicles’ response element ‘License’.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Session identifier

status Required {bool} Boolean value if active (0/1)

vin Optional {string} Vehicle identification number

vehicleYear Optional {int} Vehicle year

vehicleMake Optional {string} Vehicle model

vehicleModel Optional {string} Vehicle model

vehicleColor Optional {string} vehicle color

vehicleName Required {string} Vehicle name

vehicleType Required {string} Vehicle type

registrationId Required {string} Vehicle registration

expirationDate Required {date} Vehicle registration expiration

capacityTaxiLivery Optional {int} Vehicle taxi/livery capacity

capacityAmbulatory Optional {int} vehicle ambulatory capacity

capacityWheelchair Optional {int} vehicle wheelchair capacity

capacityStretcher Optional {int} vehicle stretcher capacity

capacityBLS Optional {int} vehicle BLS capacity

capacityALS Optional {int} vehicle ALS capacity

newVehicleName Optional {string} new vehicle name.

NOTE: if “ADD” request is

flagged to specifically
insert

newRegistrationId Optional {string} new vehicle license plate

39
 NOTE: if “ADD” request is
flagged to specifically
insert

Request Examples

XML

1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <VehicleUpdate version="4">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <status>0</status>
6 <vehicleName>ford650-3</vehicleName>
7 <vehicleType>Livery</vehicleType>
8 <registrationId>AZ12350</registrationId>
9 <expirationDate>03/31/2024</expirationDate>
10 <vin>3FRNF65294V607743</vin>
11 <vehicleYear>2004</vehicleYear>
12 <vehicleMake>FORD</vehicleMake>
13 <vehicleModel>F-650</vehicleModel>
14 <vehicleColor>Red White</vehicleColor>
15 <capacityTaxiLivery>10</capacityTaxiLivery>
16 <capacityAmbulatory>0</capacityAmbulatory>
17 <capacityWheelchair>0</capacityWheelchair>
18 <capacityStretcher>0</capacityStretcher>
19 <capacityBLS>0</capacityBLS>
20 <capacityALS>0</capacityALS>
21 <newVehicleName>ADD</newVehicleName>
22 <newRegistrationId>ADD</newRegistrationId>
23 </VehicleUpdate>
24 </TPRequest>

JSON

1 {
2 "sessionIdentifier": "{{sessionIdentifier}}",
3 "call": "VehicleUpdate",
4 "version": 4,
5 "status": "0",
6 "vehicleName": "ford650",
7 "vehicleType": "Livery",
8 "registrationId": "AZ12347",
9 "expirationDate": "09/30/2023",
10 "vin": "3FRNF65W38V652458",
11 "vehicleYear": "2008",
12 "vehicleMake": "FORD",
13 "vehicleModel": "F-650",
14 "vehicleColor": "White",
15 "capacityTaxiLivery": "10",
16 "capacityAmbulatory": "0",
17 "capacityWheelchair": "0",
18 "capacityStretcher": "0",
19 "capacityBLS": "0",
20 "capacityALS": "0",
21 "newVehicleName": "ADD",
22 "newRegistrationId": "ADD"
23 }

40
 Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

VehicleUpdate Required {string} 1000, 40XX

responseStatus Required {int} See response chart

vehicleId Required {int} Vehicle object id

updateStatus Required {string} Added / Updated

vehicleName Required {string} Vehicle name

vehicleType Required {string} Vehicle type

vehicleStatus Required {bool} Active status (true / false)

vehicleRegistration Required {string} Vehicle registration number

vin Required {string} Vehicle identification number

color Required {string} Vehicle color

year Required {int} Vehicle year

make Required {string} Vehicle make

model Required {string} Vehicle model

capacityTaxiLivery Required {int} Vehicle taxi/livery capacity

capacityAmbulatory Required {int} Vehicle ambulatory capacity

capacityWheelchair Required {int} Vehicle wheelchair capacity

capacityStretcher Required {int} Vehicle stretcher capacity

capacityBLS Required {int} Vehicle BLS capacity

capacityALS Required {int} Vehicle ALS capacity

vehicleRegistrationExpiration Required {date} Vehicle expiration date

dateModified Required {date} Date this vehicle record was last

updated

Response Examples

XML

1 <?xml version="1.0" encoding="utf-8" ?>

2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>
5 <![CDATA[Success.]]>
6 </callMessage>
7 <VehicleUpdate version="4">
8 <responseStatus>1000</responseStatus>
9 <responseMessage>

41
10 <![CDATA[Success.]]>
11 </responseMessage>
12 <record>
13 <vehicleId>1690227</vehicleId>
14 <updateStatus>Added</updateStatus>
15 <vehicleName>ford650-3</vehicleName>
16 <vehicleType>Livery</vehicleType>
17 <vehicleStatus>0</vehicleStatus>
18 <vehicleRegistration>AZ12350</vehicleRegistration>
19 <vin>3FRNF65294V607743</vin>
20 <color>Red White</color>
21 <year>2004</year>
22 <make>Ford</make>
23 <model>F-650</model>
24 <capacityTaxiLivery>10</capacityTaxiLivery>
25 <capacityAmbulatory></capacityAmbulatory>
26 <capacityWheelchair></capacityWheelchair>
27 <capacityStretcher></capacityStretcher>
28 <capacityBLS></capacityBLS>
29 <capacityALS></capacityALS>
30 <vehicleRegistrationExpiration>03/31/2024 00:00:00</vehicleRegistrationExpiration>
31 <dateModified>08/31/2023 15:07:54</dateModified>
32 </record>
33 </VehicleUpdate>
34 </TPResponse>

JSON

1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "VehicleUpdate": {
7 "version": "4",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "records": [
11 {
12 "vehicleId": "1690226",
13 "updateStatus": "Added",
14 "vehicleName": "ford650",
15 "vehicleType": "Livery",
16 "vehicleStatus": "1",
17 "vehicleRegistration": "AZ12347",
18 "vin": "3FRNF65W38V652458",
19 "color": "White",
20 "year": 2008,
21 "make": "",
22 "model": "2008",
23 "capacityTaxiLivery": 10,
24 "capacityAmbulatory": null,
25 "capacityWheelchair": 0,
26 "capacityStretcher": 0,
27 "capacityBLS": 0,
28 "capacityALS": 0,
29 "vehicleRegistrationExpiration": "09/30/2023 00:00:00",
30 "dateModified": "08/30/2023 13:22:11"

42
 31 }
32 ]
33 }
34 }
35 }

VehicleUpdate | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

43
FindVehicleByVIN

FindVehicleByVIN | Request Elements | Request Examples | JSON | Response Elements | Response Examples | JSON

FindVehicleByVIN v#

Returns the current status that MAS has received from NY State DMV regarding a specific VIN.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Session identifier

status Required {bool} Boolean value if active (0/1)

vin Required {string} Vehicle identification number

Request Examples

XML
6015 = Invalid Request

Request must use JSON

JSON 1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "findVehicleByVin",
5 "version": 1,
6 "vin": "AAPV0120470409401"
7 }
8 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

findVehicleByVin Required {string} 1000, 40XX

responseStatus Required {int} See response chart

vehicle Optional {object} Vehicle response object

recordType Required {string} Vehicle record type

vin Required {string} VIN number

registrationClass Required {string} Registration Class

city Required {string} Registered City

state Required {string} Registered State

zip Required {string} Registered Zip

44
county Required {string} Registered County

modelYear Required {int} Vehicle model year

model Required {string} Vehicle model

make Required {string} Vehicle make

fuelType Required {string} Fuel type

passengers Required {string} Number of passengers

unladenWeight Required {string} Vehicle weight

maximumGrossWeight Required {int} Maximum gross weight

regValidDate Required {date} Registration valid date

regExpirationDate Required {date} Registration expiration date

color Required {string} Vehicle color

scofflawIndicator Required {boolean} Outstanding scofflaws against

vehicle

suspensionIndication Required {boolean} Outstanding suspension against

vehicle

revocationIndicator Required {boolean} Vehicle title or registration has

been revoked

bodyType Required {string} Vehicle body type

createdDate Required {datetime} Record created date time

Response Examples

XML
6014 = Invalid Accept

Must use JSON

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "findVehicleByVin": {
7 "version": "1",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "vehicle": {
11 "recordType": "VEH",
12 "vin": "AAPV0120470409401",
13 "registrationClass": "PAS",
14 "city": "EAGLE BAY",
15 "state": "NY",
16 "zip": "13331",
17 "county": "HAMILTON",
18 "modelYear": "1989",
19 "model": "1989",

45
 20 "make": "LNDR",
21 "fuelType": "GAS",
22 "passengers": null,
23 "unladenWeight": "4200",
24 "maximumGrossWeight": null,
25 "regValidDate": "2022/06/21",
26 "regExpirationDate": "2024/08/14",
27 "color": "White",
28 "scofflawIndicator": false,
29 "suspensionIndicator": false,
30 "revocationIndicator": false,
31 "bodyType": "SUBURBAN",
32 "createdDate": "2023/08/18 16:24:10"
33 }
34 }
35 }
36 }

FindVehicleByVIN | Request Elements | Request Examples | JSON | Response Elements | Response Examples | JSON

46
Driver

Driver APIs
The collection of Driver APIs, includes getter and setter endpoints for managing company drivers.

API List

ListDrivers
GetDriver
NewDriver
UpdateDriver
DisableDriver
EnableDriver

47
ListDrivers

ListDrivers | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

ListDrivers v5

List the drivers registered for this Transportation Provider.

Some of the “driver” API calls require a unique driver ID that represents the primary key id used in the database.
ListDrivers returns this value as “ID” in the response. In XML it is an attribute and in the JSON response it is an element.
The Driver ID can also be retrieved from Transportation Provider Profile.

Request Elements Required or Optional Type Definition

List Drivers version Required {int} Version of the List Drivers Call

Session Identifier Required. {sessionId} Session Identifier

disabled Required {bool} “0” Returns “Inactive” / NOT

“Active” drivers
“1” Returns “Active” drivers

profileID Optional {int} Transportation Provider Id

allDrivers Optional {boolean} Show all drivers (overrides the

required disabled request param)

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <listDrivers version="5">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <disabled>0</disabled>
6 </listDrivers>
7 </TPRequest>

JSON 1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "listDrivers",
5 "version": 5,
6 "disabled": "0",
7 "allDrivers":true
8 }
9 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

48
Call Status Required {int} 1000, 40XX

Call Message Required. {int} The success of the message

List Drivers Version Required. {int} The version of the call for the list
of drivers

responseStatus Required {int} Response success or error code

responseMessage Required {string} Response message “success” or

error message

Driver Count Required. {int} The number of drivers returned

(xml attribute only)

ID Required. {int} The id of the driver returned

Status Required {int} Driver status

First Name Required. {shortstring} The first name of the driver – this
will repeat for each driver
returned

Last Name Required. {shortstring} The last name of the driver – this
will repeat for each driver
returned

Expiration Required {datetime} The drivers license expiration

License Required {int} The status of the call (Success

or error)

LicenseState Required {string} State that issued the drivers

license

MedicaidCountyNumber Required {int} TP’s Medicaid county number

this driver is connected with.
County 99 is unified across all

allowLogin Required {bool} True/False allow driver to login

Phone_Number Required {phone} Driver’s phone number

Email_Address Required {email} Driver’s email address

Birth_Date Required (JSON Only) {date} Driver’s birthdate

CTAA_Email_Address Required (JSON Only) {email} Email address used for

certification via CTAA

MVR_Check_Date Required (JSON Only) {date} MVR last checked date

MVR_Check_Status Required (JSON Only) {boolean} Status of the MVR check

DriverTraining Required (JSON Only) {array} Driver training array of objects

(or empty)

ID Required (JSON Only) {int} Internal record ID for the training

record

49
Trans_Provider_Driver_ID Required (JSON Only) {int} Transportation provider driver ID

Certificate_ID Required (JSON Only) {int} Internal record ID for certificate

type

Training_Name Required (JSON Only) {string} Type of training (name)

Certificate_Expiration Required (JSON Only) {date} Expiration of the certificate

TP_Flagged Required (JSON Only) {boolean} Is the transportation provider

flagged

TP_Flagged_Reason Required (JSON Only) {string} Reason the transportation

provider is flagged

DriverExclusions Required (JSON Only) {array} Driver exclusions array of objects

(or empty)

ID Required (JSON Only) {int} Internal record ID for the

exclusion

Trans_Provider_Driver_ID Required (JSON Only) {int} Transportation provider driver ID

Exclusion_LastCheck_Date Required (JSON Only) {date} Last time that exclusions were
checked for

Exclusion_NextCheck_Date Required (JSON Only) {date} Next time the exclusions will be
checked for

Exclusion_Check_Status Required (JSON Only) {boolean] Are there any exclusions for the
driver?

DMF Required (JSON Only) {boolean} DMF Exclusion

OMIG Required (JSON Only) {boolean} OMIG Exclusion

SAM Required (JSON Only) {boolean} SAM Exclusion

OIG Required (JSON Only) {boolean} OIG Exclusion

OTHER Required (JSON Only) {boolean} OTHER exclusion

Response Examples

50
XML 1 <?xml version="1.0" encoding="utf-8" ?>
2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>
5 <![CDATA[Success.]]>
6 </callMessage>
7 <listDrivers version="5">
8 <responseStatus>1000</responseStatus>
9 <responseMessage>
10 <![CDATA[Success.]]>
11 </responseMessage>
12 <drivers count="65">
13 <driver id="1837371">
14 <Status>0</Status>
15 <First_Name>Brian</First_Name>
16 <Last_Name>ASHer</Last_Name>
17 <Expiration>08/06/2026 00:00:00</Expiration>
18 <License>wqeqeqwer</License>
19 <LicenseState>HI</LicenseState>
20 <MedicaidCountyNumber>99</MedicaidCountyNumber>
21 <allowLogin>1</allowLogin>
22 <Phone_Number>555-555-5454</Phone_Number>
23 <Email_Address>
24 <![CDATA[[email protected]]]>
25 </Email_Address>
26 <MedicaidCountyNumber>99</MedicaidCountyNumber>
27 <Birth_Date></Birth_Date>
28 <CTAA_Email_Address>
29 <![CDATA[[email protected]]]>
30 </CTAA_Email_Address>
31 <MVR_Check_Date></MVR_Check_Date>
32 <MVR_Check_Status></MVR_Check_Status>
33 <Last_Update>08/22/2023</Last_Update>
34 <Social_Security_Number></Social_Security_Number>
35 <Exclusion_Check_Status>false</Exclusion_Check_Status>
36 <driverTraining>
37 <ID>1</ID>
38 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
39 <Certificate_ID>1</Certificate_ID>
40 <Training_Name>MAS Driver Education</Training_Name>
41 <Certificate_Expiration>10/04/2024</Certificate_Expiration>
42 <ID>2</ID>
43 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
44 <Certificate_ID>2</Certificate_ID>
45 <Training_Name>Basic PASS</Training_Name>
46 <Certificate_Expiration>11/05/2024</Certificate_Expiration>
47 </driverTraining>
48 <driverExclusions>
49 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
50 <ID>1</ID>
51 <Exclusion_Name>NYS OMIG</Exclusion_Name>
52 <Exclusion_LastCheck_Date>08/29/2023</Exclusion_LastCheck_Date>
53 <Exclusion_NextCheck_Date>09/29/2023</Exclusion_NextCheck_Date>
54 <DMF>false</DMF>
55 <OMIG>false</OMIG>
56 <SAM>false</SAM>
57 <OIG>false</OIG>
58 <OTHER>false</OTHER>
59 </driverExclusions>

51
 60 </driver>
61 ...
62 <driver id="1994037">
63 <Status>1</Status>
64 <First_Name>Bernie</First_Name>
65 <Last_Name>Barrett</Last_Name>
66 <Expiration>08/08/2025 00:00:00</Expiration>
67 <License>45632187</License>
68 <LicenseState>NY</LicenseState>
69 <MedicaidCountyNumber>99</MedicaidCountyNumber>
70 <allowLogin>1</allowLogin>
71 <Phone_Number>5187896523</Phone_Number>
72 <Email_Address>
73 <![CDATA[bb09876%@gmail.com]]>
74 </Email_Address>
75 <MedicaidCountyNumber>99</MedicaidCountyNumber>
76 <Birth_Date></Birth_Date>
77 <CTAA_Email_Address>
78 <![CDATA[bb09876%@gmail.com]]>
79 </CTAA_Email_Address>
80 <PASS_Basic_Expiration_Date></PASS_Basic_Expiration_Date>
81 <PASS_Full_Expiration_Date></PASS_Full_Expiration_Date>
82 <MASS_Driver_Ed_Expiration_Date></MASS_Driver_Ed_Expiration_Date>
83 <Exclusion_Check_Date></Exclusion_Check_Date>
84 <Exclusion_Check_Status></Exclusion_Check_Status>
85 <MVR_Check_Date></MVR_Check_Date>
86 <MVR_Check_Status></MVR_Check_Status>
87 <Last_Update>08/29/2023</Last_Update>
88 <Social_Security_Number></Social_Security_Number>
89 <Exclusion_Check_Status>false</Exclusion_Check_Status>
90 <driverTraining>
91 </driverTraining>
92 <driverExclusions>
93 </driverExclusions>
94 </driver>
95 </drivers>
96 </listDrivers>
97 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "listDrivers": {
7 "version": "5",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "drivers": [
11 {
12 "ID": "1837371",
13 "Status": "0",
14 "First_Name": "Brian",
15 "Last_Name": "ASHer",
16 "Expiration": "08/06/2026 00:00:00",
17 "License": "wqeqeqwer",
18 "LicenseState": "HI",
19 "MedicaidCountyNumber": "99",
20 "allowLogin": 1,

52
 21 "Phone_Number": "555-555-5454",
22 "Email_Address": "[email protected]",
23 "Birth_Date": "",
24 "CTAA_Email_Address": "[email protected]",
25 "MVR_Check_Date": "",
26 "MVR_Check_Status": "",
27 "Last_Update": "08/22/2023",
28 "Social_Security_Number": "",
29 "Exclusion_Check_Status": false,
30 "DriverTraining": [
31 {
32 "ID": "1",
33 "Trans_Provider_Driver_ID": "1837371",
34 "Certificate_ID": "1",
35 "Training_Name": "MAS Driver Education",
36 "Certificate_Expiration": "10/04/2024"
37 },
38 {
39 "ID": "2",
40 "Trans_Provider_Driver_ID": "1837371",
41 "Certificate_ID": "2",
42 "Training_Name": "Basic PASS",
43 "Certificate_Expiration": "11/05/2024"
44 }
45 ],
46 "DriverExclusions": [
47 {
48 "Trans_Provider_Driver_ID": "1837371",
49 "ID": "1",
50 "Exclusion_Name": "NYS OMIG",
51 "Exclusion_LastCheck_Date": "08/29/2023",
52 "Exclusion_NextCheck_Date": "09/29/2023",
53 "DMF": false,
54 "OMIG": false,
55 "SAM": false,
56 "OIG": false,
57 "OTHER": false
58 }
59 ]
60 },
61 ...
62 {
63 "ID": "1994037",
64 "Status": "1",
65 "First_Name": "Bernie",
66 "Last_Name": "Barrett",
67 "Expiration": "08/08/2025 00:00:00",
68 "License": "45632187",
69 "LicenseState": "NY",
70 "MedicaidCountyNumber": "99",
71 "allowLogin": 1,
72 "Phone_Number": "5187896523",
73 "Email_Address": "bb09876%@gmail.com",
74 "Birth_Date": "",
ListDrivers | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON
75 "CTAA_Email_Address": "bb09876%@gmail.com",
76 "PASS_Basic_Expiration_Date": "",
77 "PASS_Full_Expiration_Date": "",
78 "MASS_Driver_Ed_Expiration_Date": "",
79 "Exclusion_Check_Date": "",
80 "Exclusion_Check_Status": "",

53
81 "MVR_Check_Date": "",
82 "MVR_Check_Status": "",
83 "Last_Update": "08/29/2023",
84 "Social_Security_Number": "",
85 "DriverTraining": [],
86 "DriverExclusions": []
87 }
88 ]
89 }
90 }
91 }

54
GetDriver

GetDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

GetDriver v5

Returns information related to a specific Driver.

Uses unique driverId .

Response includes many details including the driver’s credentialing and exclusion status.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Session Id for the call

driverId Required {int} Driver object id

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <getDriver version="5">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <driverId>1837371</driverId>
6 </getDriver>
7 </TPRequest>

JSON 1 {
2 "TPRequest": {
3 "sessionIdentifier": "{{sessionIdentifier}}",
4 "call": "getDriver",
5 "version": 5,
6 "driverId": 1837371
7 }
8 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 40XX

responseMessage Required {shortstring} See response chart

ID Required {int} Driver object id

Status Required {bool} Driver status

1 active
0 not active

First_Name Required {string} Driver First Name

55
Last_Name Required {string} Driver Last Name

License Required {string} Driver license

Expiration Required {date} Driver license expiration

LicenseState Required {string} Two char state abbreviation

MedicaidCountyNumber Required {int} Medicaid county number

allowLogin Required {bool} Boolean 0/1

PhoneNumber Required {phone} Driver phone number

userName Required {string} Driver username (if login true)

EmailAddress Required {email} Driver email address

Birth_Date Required {date} Driver birth date

CTAA_Email_Address Required {email} Driver email address for CTAA

MVR_Check_Date Required {date} MVR check date

MVR_Check_Status Required MVR status

tpId Required {int} Transportation Provider internal

id

Exclusion_Check_Status Required {boolean} Does the driver have any

exclusions?

DriverTraining Required {array} Array of driver training records;

will be an empty array if there
are no records

DriverTraining ID Required {int} Driver training internal id

DriverTraining Required {int} Driver record internal id

Trans_Provider_Driver_ID

DriverTraining Certificate_ID Required {int} Driver certificate internal id

DriverTraining Training_Name Required {string} Driver certificate name

DriverTraining Required {date} Driver certificate expiration date

Certificate_Expiration

DriverTraining TP_Flagged Required {boolean} True/False if driver is flagged

DriverTraining Required {string} Description for why flagged

TP_Flagged_Reason

DriverExclusions Required {array} Array of driver exclusion records;

will be an empty array if there
are no records

DriverExclusions ID Required {int} Driver exclusion internal id

DriverExclusions Required {int} Driver record internal id

Trans_Provider_Driver_ID

56
DriverExclusions Required {date} Date driver exclusion was last
Exclusion_LastCheck_Date checked

DriverExclusions Required {date} Next date the driver exclusion is

Exclusion_NextCheck_Date checked

DriverExclusions DMF Required {boolean} True if the driver has a DMF

exclusion

DriverExclusions OMIG Required {boolean} True if the driver has an OMIG

exclusion

DriverExclusions SAM Required {boolean} True if the driver has a SAM

exclusion

DriverExclusions OIG Required {boolean} True if the driver has an OIG

exclusion

DriverExclusions OTHER Required {boolean} True if the driver has an other

exclusion

CtaaExpirationDate Required {date} CTAA expiration date

LatestCertNum Required {int} Latest certification number

LatestCertType Required {string} Certificate name

Response Examples

57
XML 1 <?xml version="1.0" encoding="utf-8" ?>
2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>
5 <![CDATA[Success.]]>
6 </callMessage>
7 <getDriver version="5">
8 <responseStatus>1000</responseStatus>
9 <responseMessage>
10 <![CDATA[Success.]]>
11 </responseMessage>
12 <drivers count="1">
13 <driver id="1837371">
14 <Status>0</Status>
15 <First_Name>Brian</First_Name>
16 <Last_Name>ASHer</Last_Name>
17 <Expiration>08/06/2026 00:00:00</Expiration>
18 <License>wqeqeqwer</License>
19 <LicenseState>HI</LicenseState>
20 <MedicaidCountyNumber>99</MedicaidCountyNumber>
21 <allowLogin>1</allowLogin>
22 <PhoneNumber>555-555-5454</PhoneNumber>
23 <userName>basher705</userName>
24 <EmailAddress>
25 <![CDATA[[email protected]]]>
26 </EmailAddress>
27 <Birth_Date></Birth_Date>
28 <CTAA_Email_Address>
29 <![CDATA[[email protected]]]>
30 </CTAA_Email_Address>
31 <MVR_Check_Date></MVR_Check_Date>
32 <MVR_Check_Status></MVR_Check_Status>
33 <tpId>54066</tpId>
34 <Exclusion_Check_Status>true</Exclusion_Check_Status>
35 <driverTraining>
36 <Item>
37 <ID>1</ID>
38 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
39 <Certificate_ID>1</Certificate_ID>
40 <Training_Name>MAS Driver Education</Training_Name>
41 <Certificate_Expiration>10/04/2024</Certificate_Expiration>
42 <TP_Flagged>false</TP_Flagged>
43 <TP_Flagged_Reason></TP_Flagged_Reason>
44 </Item>
45 <Item>
46 <ID>2</ID>
47 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
48 <Certificate_ID>2</Certificate_ID>
49 <Training_Name>Basic PASS</Training_Name>
50 <Certificate_Expiration>11/05/2024</Certificate_Expiration>
51 <TP_Flagged>false</TP_Flagged>
52 <TP_Flagged_Reason></TP_Flagged_Reason>
53 </Item>
54 </driverTraining>
55 <driverExclusions>
56 <Item>
57 <ID>1</ID>
58 <Trans_Provider_Driver_ID>1837371</Trans_Provider_Driver_ID>
59 <Exclusion_LastCheck_Date>08/29/2023</Exclusion_LastCheck_Date>

58
 60 <Exclusion_NextCheck_Date>09/29/2023</Exclusion_NextCheck_Date>
61 <DMF>false</DMF>
62 <OMIG>true</OMIG>
63 <SAM>false</SAM>
64 <OIG>true</OIG>
65 <OTHER>false</OTHER>
66 </Item>
67 </driverExclusions>
68 <CtaaExpirationDate></CtaaExpirationDate>
69 <LatestCertNum></LatestCertNum>
70 <LatestCertType></LatestCertType>
71 </driver>
72 </drivers>
73 </getDriver>
74 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "getDriver": {
7 "version": "5",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "drivers": [
11 {
12 "ID": "1837371",
13 "Status": "0",
14 "First_Name": "Brian",
15 "Last_Name": "ASHer",
16 "Expiration": "08/06/2026 00:00:00",
17 "License": "wqeqeqwer",
18 "LicenseState": "HI",
19 "MedicaidCountyNumber": "99",
20 "allowLogin": 1,
21 "PhoneNumber": "555-555-5454",
22 "userName": "basher705",
23 "EmailAddress": "[email protected]",
24 "Birth_Date": null,
25 "CTAA_Email_Address": "[email protected]",
26 "MVR_Check_Date": null,
27 "MVR_Check_Status": null,
28 "tpId": null,
29 "Exclusion_Check_Status": true,
30 "DriverTraining": [
31 {
32 "ID": 1,
33 "Trans_Provider_Driver_ID": 1837371,
34 "Certificate_ID": 1,
35 "Training_Name": "MAS Driver Education",
36 "Certificate_Expiration": "10/04/2024",
37 "TP_Flagged": false,
38 "TP_Flagged_Reason": null
39 },
40 {
41 "ID": 2,
42 "Trans_Provider_Driver_ID": 1837371,
GetDriver | 43
Request Elements | Request Examples | XML | JSON | Response
"Certificate_ID": 2, Elements | Response Examples | XML | JSON

59
44 "Training_Name": "Basic PASS",
45 "Certificate_Expiration": "11/05/2024",
46 "TP_Flagged": false,
47 "TP_Flagged_Reason": null
48 }
49 ],
50 "DriverExclusions": [
51 {
52 "ID": 1,
53 "Trans_Provider_Driver_ID": 1837371,
54 "Exclusion_LastCheck_Date": "08/29/2023",
55 "Exclusion_NextCheck_Date": "09/29/2023",
56 "DMF": false,
57 "OMIG": true,
58 "SAM": false,
59 "OIG": true,
60 "OTHER": false
61 }
62 ],
63 "CtaaExpirationDate": null,
64 "LatestCertNum": null,
65 "LatestCertType": null
66 }
67 ]
68 }
69 }
70 }

60
NewDriver

NewDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

NewDriver v6

Setter method that will create a new driver which is associated with the current Transportation Provider.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Id for the session

firstName Required {element} First name of the driver

lastName Required {bool} Last name of the driver

licenseState Required {shortstring} Driver license state issued

licenseNumber Required {shortstring} Driver license number

licenseExpiration Required {shortstring} Driver license expiration

directPhone Optional {phone} Driver cell phone

allowLogin Optional {boolean} Allow driver to login to portal

emailAddress Required {email} Driver’s email address

SSN Optional {string} Driver’s social security number

BirthDate Optional {date} Driver’s birth date

CTAAEmailAddress Optional {email} Driver’s email address for CTAA

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <newDriver version="6">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <firstName>Elaine</firstName>
6 <lastName>O'Connor Nardo</lastName>
7 <licenseState>NY</licenseState>
8 <licenseNumber>32982067</licenseNumber>
9 <licenseExpiration>01/01/2024</licenseExpiration>
10 <directPhone>1234567896</directPhone>
11 <allowLogin>0</allowLogin>
12 <emailAddress>[email protected]</emailAddress>
13 <SSN>859657548</SSN>
14 <BirthDate>04/06/1952</BirthDate>
15 <CTAAEmailAddress>[email protected]</CTAAEmailAddress>
16 </newDriver>
17 </TPRequest>

JSON

61
 1 {
2 "firstName": "Elaine",
3 "lastName": "O'Connor Nardo",
4 "licenseState": "NY",
5 "licenseNumber": "32982067",
6 "licenseExpiration": "01/01/2024",
7 "directPhone": "1234567896",
8 "allowLogin": "0",
9 "emailAddress": "[email protected]",
10 "SSN": "859657548",
11 "BirthDate": "04/06/1952",
12 "CTAAEmailAddress": "[email protected]",
13 "sessionIdentifier": "{{sessionIdentifier}}",
14 "call": "newDriver",
15 "version": 6
16 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 40XX

responseMessage Required {string} See Response Status

(Appendix)

driverId Required {int} Generated driver id for new

driver

userId {string} Generated userId if login was

TRUE

username {string} Generated username if login was

TRUE

Response Examples

XML 1 <?xml version="1.0" encoding="utf-8" ?>

2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <newDriver version="6">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 <DriverLogin>
9 <driverId>1839968</driverId>
10 <userId></userId>
11 <username></username>
12 </DriverLogin>
13 </newDriver>
14 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Production",
4 "callStatus": "1000",

62
 5 "callMessage": "Success.",
6 "newDriver": {
7 "version": "6",
8 "responseStatus": "1000",
9 "responseMessage": "Success.",
10 "DriverLogin": {
11 "driverID": "1839967",
12 "userId": "",
13 "username": ""
14 }
15 }
16 }
17 }

NewDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

63
UpdateDriver

UpdateDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

UpdateDriver v6

Revise Driver record indicated by driverId to match the request parameters.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Id for the session

driverId Required {int} Driver record ID in MAS system

firstName Required {element} First name of the driver

lastName Required {bool} Last name of the driver

licenseState Required {shortstring} Driver license state issued

licenseNumber Required {shortstring} Driver license number

licenseExpiration Required {shortstring} Driver license expiration

directPhone Optional {phone} Driver cell phone

allowLogin Optional {boolean} Allow driver to login to portal

emailAddress Optional {email} Driver’s email address

SSN Optional {string} Driver’s social security number

BirthDate Optional {date} Driver’s birth date

CTAAEmailAddress Optional {email} Driver’s CTAA email address

Request Examples

XML

1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <updateDriver version="6">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <version>6</version>
6 <driverId>1728208</driverId>
7 <firstName>Bance</firstName>
8 <lastName>Bon</lastName>
9 <licenseState>NY</licenseState>
10 <licenseNumber>649179878</licenseNumber>
11 <licenseExpiration>2026-02-12</licenseExpiration>
12 <directPhone>9145551213</directPhone>
13 <allowLogin>1</allowLogin>
14 <emailAddress>[email protected]</emailAddress>
15 <SSN>111223333</SSN>
16 <BirthDate>09/02/1960</BirthDate>
17 <CTAAEmailAddress>[email protected]</CTAAEmailAddress>

64
18 </updateDriver>
19 </TPRequest>

JSON

1 {
2 "sessionIdentifier": "{{sessionIdentifier}}",
3 "call": "updateDriver",
4 "version": 6,
5 "driverId": "1728292",
6 "firstName": "Bance",
7 "lastName": "Bon",
8 "licenseState": "NY",
9 "licenseNumber": "343432342",
10 "licenseExpiration": "07/02/2025",
11 "directPhone": "5185559999",
12 "allowLogin": "1",
13 "emailAddress": "[email protected]",
14 "SSN": "111223333",
15 "BirthDate": "09/02/1960",
16 "CTAAEmailAddress": "[email protected]"
17 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 1001, 1002, 6201

responseMessage Required {string} See response chart

Response Examples

XML

1 <?xml version="1.0" encoding="utf-8" ?>

2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <updateDriver version="6">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 </updateDriver>
9 </TPResponse>

JSON

1 {
2 "TPResponse": {
3 "mode": "Testing",
4 "callStatus": "1000",
5 "callMessage": "Success.",
6 "updateDriver": {
7 "version": "6",
8 "responseStatus": "1000",
9 "responseMessage": "Success."
10 }

65
 11 }
12 }

UpdateDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

66
DisableDriver

DisableDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

DisableDriver v5

Set status of a matching Driver record to 0 and “disable” the Driver.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Id for the session

driverId Required {int} Driver record ID in MAS system

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <disableDriver version="5">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <driverId>1728208</driverId>
6 </disableDriver>
7 </TPRequest>

JSON 1 {
2 "sessionIdentifier": "{{sessionIdentifier}}",
3 "call": "disableDriver",
4 "version": 5,
5 "driverId": "1728292"
6 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 3058, 400X, 500X

responseMessage Required {string} See Response Status

(Appendix)

Response Examples

67
 XML 1 <?xml version="1.0" encoding="utf-8" ?>
2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <disableDriver version="5">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 </disableDriver>
9 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Testing",
4 "callStatus": "1000",
DisableDriver
5 | Request Elements | Request
"callMessage": Examples | XML | JSON | Response Elements | Response Examples | XML | JSON
"Success.",
6 "disableDriver": {
7 "version": "5",
8 "responseStatus": "1000",
9 "responseMessage": "Success."
10 }
11 }
12 }

68
EnableDriver

EnableDriver | Request Elements | Request Examples | XML | JSON | Response Elements | Response Examples | XML | JSON

EnableDriver v5

Set status of a matching Driver record to 1 and “enable” the Driver.

Request Elements Required or Optional Type Definition

sessionIdentifier Required {sessionId} Id for the session

driverId Required {int} Driver record ID in MAS system

Request Examples

XML 1 <?xml version="1.0" encoding="utf-8"?>

2 <TPRequest>
3 <enableDriver version="5">
4 <sessionIdentifier>{{sessionIdentifier}}</sessionIdentifier>
5 <driverId>1728208</driverId>
6 </enableDriver>
7 </TPRequest>

JSON 1 {
2 "sessionIdentifier": "{{sessionIdentifier}}",
3 "call": "enableDriver",
4 "version": 5,
5 "driverId": "1728292"
6 }

Response Elements Required or Optional Type Definition

version Required {int} current version denoted in

header and examples

responseStatus Required {int} 1000, 3058, 400X, 500X

responseMessage Required {string} See Response Status

(Appendix)

Response Examples

69
 XML 1 <?xml version="1.0" encoding="utf-8" ?>
2 <TPResponse mode="Production">
3 <callStatus>1000</callStatus>
4 <callMessage>Success.</callMessage>
5 <enableDriver version="5">
6 <responseStatus>1000</responseStatus>
7 <responseMessage>Success.</responseMessage>
8 </enableDriver>
9 </TPResponse>

JSON 1 {
2 "TPResponse": {
3 "mode": "Testing",
4 "callStatus": "1000",
EnableDriver5 | Request Elements | Request
"callMessage": Examples | XML | JSON | Response Elements | Response Examples | XML | JSON
"Success.",
6 "enableDriver": {
7 "version": "5",
8 "responseStatus": "1000",
9 "responseMessage": "Success."
10 }
11 }
12 }

70
Session Management

Session Management APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

StartSession
EndSession

71
Trip Management

Trip Management APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

UpdateProviderAvailability

PullRoster

RefuseTrip

TripRoster

DispatchLeg

ReassignDriverVehicle

UpdateProviderZipCodes

TransportationProviderUpdateServiceAreas

TransportationProviderUpdateCapacity

72
GPS

GPS APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

UpdateVehicleLocation
GetCurrentVehicleLocation
UpdateGPS
GetTripLegsTracking

73
Attestation

Attestation APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

InvoiceAttest
GetAttestation
AwaitingAttestation

74
Corrections

Corrections APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

OpenCorrections
NewCorrectionRequest
GetCorrectionsRequest
DeleteCorrectionRequest
EditCorrectionRequest
ListServiceCorrections

75
Informational

Informational APIs

For the API’s listed below please refer to the API Endpoint Documentation v5.5

API List

GetCounties
GetCountyZips
GetBillingCompanies
GetRoutingCompanies

76
Appendix

Type Definitions
{replace this text with Descriptive Narrative of the API section grouping}

Definitions and Reference

Response Status
Token Description
Vehicle Type
String Variables
Correction Id Types
Correction Status Values
Mileage Upgrade Correction Values
Trip Status and Leg Status
Trip Reassign/Refusal Id Types
Driver and Vehicle Reassign Status
Values

77
Response Status

Response Status Codes and Descriptions

1000 Success.

1001 Driver Added.

1002 Driver Updated.

1003 Vehicle Added.

1004 Vehicle Updated.

2000 Warning.

2003 Expired Password. This user<@SQ>s password has expired and

needs to be reset.

2050 Batch execution had failed runs

2100 No Results.

3000 Driver Failure.

3001 Incorrect Provider Number.

3002 Invalid Expiration date.

3003 Invalid Issue State.

3004 Full Driver Name Missing.

3005 Invalid Motorist ID.

3006 Invalid Driver Status.

3007 Duplicate Email Address

3008 Duplicate License and State

3010 Vehicle Failure.

3011 Incorrect Provider Number.

3012 Invalid Expiration date.

3013 Invalid Issue State.

3014 Full Vehicle Name Needed.

3015 Invalid Registration ID.

3016 Invalid Vehicle Type.

3018 Invalid Vehicle Status.

3019 You must specify a driver or invoice number.

78
3020 You must specify a date or invoice number.

3021 No Trips Found.

3022 Invalid Invoice Number.

3023 Invalid Start Date.

3024 Invalid End Date, Must be within 30 days of Current Date.

3025 Too many Trips. More than 1000 trips found. Rerun request with
shorter date range.

3026 Open Correction. Trips with open correction requests cannot be

attested to.

3027 Correction cannot be created for this invoice.

3028 Correction with <@SQ>completed<@SQ> or <@SQ>not

needed<@SQ> status cannot be approved.

3029 Correction has already been approved.

3030 Could not determine new TP to reassign trip

3031 Error assigning new TP to trip

3032 Transportation Provider record is inactive. Check Certification.

3033 Address correction leg may only define an addressId OR placeId for
individual pickup/dropoff

3034 Correction cannot be edited for this invoice.

3035 No Trans_Provider Ids found

3045 Illegal Access. User doesn’t have permissions to use this call.

3050 No Drivers. Transportation Provider has no drivers.

3051 Invalid Driver. Driver ID was not found for Transportation Provider or
is not active.

3052 Already Started. This driver has already started another leg.

3053 Driver exists use editDriver.

3054 Driver not found.

3055 Open Correction exists. New Correction cannot be submitted.

3056 Correction cannot be submitted for trips older than 30 days.

3057 Driver MisMatch.

3058 Email address already in use. Please supply another email address.

3060 No Vehicles. Transportation Provider has no vehicles.

3061 Invalid Vehicle. Vehicle ID was not found for Transportation Provider
or is not active.

79
3071 Invalid Leg. Leg ID was not found for Tranportation Provider or is not
eligible.

3072 Already Started. This leg has already been started by another driver.

3073 Invalid Leg. Leg not started by this driver, or already complete.

3074 Not Dispatched. Leg not dispatched to this driver and/or vehicle.

3075 Already Dispatched. This leg has already been dispatched.

3076 Distance from location to great

3077 Call out of sequense - current leg tracking status is <@LITERAL

'@@trackingStatus'>

3080 Invalid Driver. No driver was found for the supplied credentials.

3081 Invalid Trip. The trip provided is not eligible or attached to this driver.
<@LITERAL @@invoiceNumber>

3082 Invalid Driver. The driver is not active.

3083 Authentication Failed. No Auth Key Found.

3084 Authentication Failed. No Trip Found.

3085 Invalid Trip. The trip provided is not eligible or attached to this
Transportation Provider. <@LITERAL @@invoiceNumber>

3086 Invalid Request. The trip appointment has passed and cannot be
reassgined.

3090 Missing Value. <@LITERAL '@@dayOfWeek'> must have a start

time.

3091 Missing Value. <@LITERAL '@@dayOfWeek'> must have an end

time.

3092 Missing Value. <@LITERAL '@@dayOfWeek'> must have a

capacity.

3093 Invalid Availablity. You must be open at least one day of the week.

3094 You must specify both a latitude and longitude.

3096 currentPage cannot exceed pageCount.

3100 Session Not Found. The sessionIdentifier does not match an existing
session. The call could not be completed.

3101 Access Violation. Testing account attempted to access non-testing

data.

3102 Two Factor Authentication. Must complete Two Factor Authentication

before making other calls.

3103 You do not have access to this profile.

3104 You are missing a unified profile. Please contact MAS Support to
have a unified profile created.

80
3105 You cannot overwrite existing GPS data

3106 You cannot change the GPS data DRIVER for this leg

3107 You cannot change the GPS data VEHICLE for this leg

3108 Invalid Location value

3109 Invalid Time_Stamp value

3110 Driver must be specified

3111 Vehicle must be specified

3112 No Show and Start/Dropoff/End cannot be attested in the same leg

3200 Invalid Google PlaceId

3499 All Legs Deleted. All legs of an invoice were deleted. Please set Trip
status to Cancelled or No Show instead.

3501 Matching trip not found. Can be because trip does not exist or
because the API key used does not match the Transportation
Provider assigned to the trip

3502 Invoice does not have ‘Eligible’ status

3503 Invoice has already been attested to

3506 Vehicle Id not found

3507 Vehicle registration expired

3508 Driver Id not found

3509 Drivers license expired

3510 Max leg mileage exceeded

3511 Service needed and no units specified

3512 Leg mileage error

3520 Original Driver/Vehicle same as new Driver/Vehicle

3900 Invalid PIN. The supplied PIN didn<@SQ>t match an API user.

4000 Missing Value.

4100 Missing Value.

5000 Incorrect Value.

6000 Error.

6010 Encryption Required. Request must use SSL/TLS.

6011 HTTP POST Required. Request must use the POST method.

6012 Invalid Content-Type. HTTP header Content-Type must be

application/xml.

81
6013 Invalid Host. HTTP header Host must be MAS | A Driving Force in
NEMT .

6014 Invalid Accept.

6015 Invalid request. Request must use JSON

6020 Invalid XML. The XML body could not be parsed.

6021 Malformed Request. The request does not have the correct
structure.

6025 Malformed request. The maxDate must be equal to or greater than

the minDate.

6030 Authentication Failed. There is no account linked to the key provided.

6031 Syntax Error. This call must not contain a sessionIdentifier.

6032 Invalid Account. The account has a problem.

6033 Production Only. This call only suppports production accounts.

6050 You do not have the correct permissions to use the call <@LITERAL
'@@callName'> version <@LITERAL '@@version'>.

6051 Session Ended. This session has been ended. Please start a new
session and resubmit your request.

6052 Session Expired. This session has expired. Please start a new
session and resubmit your request.

6053 Access Denied. Required: MAS Admin or ATM.

6054 Access Denied. Required: MAS staff or Transportation Provider with

permission to access.

6055 Access Denied. Required: Transportation Provider with permission to

access.

6090 Timeout. The request could not be completed in a reasonable

amount of time.

6098 Deprecated. Version <@LITERAL '@@version'> for call

<@LITERAL '@@callName'> has been deprecated. Please use a
newer version.

6099 No call or version. No version <@LITERAL '@@version'> for call

<@LITERAL '@@callName'> found.

6201 Syntax Error. The attributes node must contain only attribute nodes.

6999 System Error. An internal error occured. Please run your request
again.

82
Token Description

Token Descriptions

{boolean} String. Either “true” or “false”. Not case sensitive.

{int} Number. 32-bit signed whole number

{decimal} Number which can include a decimal point.

{shortString} String. Up to 250 characters

{string} String. Up to 1000 characters

{value} User entered character data with no type definition. Up to 4000

characters

{date} Date. ISO format: YYYY-MM-DD

{time} Time. 24-hour ISO format: HH:MM:SS

{timestamp} {date}T{time}

Local time: No time zone component is necessary, since MAS only

services New York State, which is completed located within the
Eastern Time Zone. All values passing through our APIs will match
the “wall clock”, whether it is Standard Time or Daylight Saving Time.

{status} String. Fixed possibilities: "success" "warning" "failure" "error"

{key} String. Authentication key assigned by MAS. Conforms to

{shortString}

{sessionId} String. Unique session identifier. Conforms to {shortString}

{VehicleType} Vehicle Type based on the following chart

{UpdateStatus} Returned Exit status for individual records based on following chart

83
Vehicle Type

Vehicle Type

Ambulance

Livery

Personal Car

Specialty

Stretcher

Taxi

Wheelchair

84
String Variables

API String Variables

string Max 1000 characters for input

shortstring Max 250 characters for input

phone Alpha-Numeric string matching a phone pattern e.g:

(XXX) XXX-XXXX

XXX-XXX-XXXX

XXXXXXXXXX

zipcode 5-digit number

email Alpha-numeric string matching an email pattern

element An XML container element which holds a specific set of data in the
request/response

medicaid A value that matches a medicaid number pattern

85
Correction Id Types

Correction id Types

1 Combine invoices

4 Missing PA Number

6 Other

8 Procedure Code/Secondary Service

9 Address

10 TP attestation error

11 Mileage

86
Correction Status Values

Correction Status Values

0 None

1 Needed

2 Completed

3 Not Needed

4 Overdue

87
Mileage Upgrade Correction Values

Mileage Upgrade Correction Values

0 Detour

1 Traffic

2 Construction

3 Accident

88
Trip Status and Leg Status

Trip Status Values

1 Any value NOT cancelled

2 Cancelled

Leg Status Values

0 Cancelled

1 Active

2 Deleted

89
Driver and Vehicle Reassign Status Values

Driver and Vehicle Reassign Status Values

-2 there is already a pending reassign

-1 no record found in Trip_Leg_Tracking

0 row in Trip_Leg_Tracking was marked as complete or none no action

to take

1 Active reassign

2 New Driver Resumed the Trip

3 Original Driver Resumed the Trip

4 Original Driver Completed the Trip

5 Reassign before trip Start

6 Vehicle change on Active Reassign

90
Trip Reassign/Refusal Id Types

Trip Reassign/Refusal Id Types

1 Zip Code

2 Capacity

3 Trans Type

4 Time of Day

91