Riders

The client can GET, POST, PATCH, PUT, and DELETE rider information.

Get By Rider ID

Passing in a single rider/passenger/patient ID returns rider/passenger/patient details.

Request

GET	{root_url}/v{version}/riders/getByRiderId

Parameter	Type	Description	Notes
api_key	string		REQUIRED
rider_id	string		REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful.
403	The api key used does not have access to this resource.

Sample 200 Response Body - Get By Rider ID Endpoint

The following sample response shows what a user would receive back.

[
  "Data": [
{
"mediroutes_rider_id": 0,
"tp_api_key": "string",
"rider_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"address":
{
"location_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"longitude": 0,
"latitude": 0
},
"phone": "string",
"funding_source_name": "string",
"space_type": "string",
"home_phone": "string",
"mobile_phone": "string",
"icd_10_codes": "string",
"date_of_birth": "string",
"is_male": true,
"is_Female": true,
"comments": "string",
"private_comments": "string",
"email": "string"
}
]

Get Rider By MediRoutes Rider Id

Passing in a single MediRoutes Rider ID returns rider/passenger/patient details.

Request

GET	{root_url}/v{version}/riders/getByMediroutesRiderId

Parameter	Type	Description	Notes
api_key	string		REQUIRED
mediroutes_rider_id	string		REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful.
403	The api key used does not have access to this resource.

Sample 200 Response Body - Get By MediRoutes Rider ID Endpoint

The following sample response shows what a user would receive back.

[
  "Data": [
{
"mediroutes_rider_id": 0,
"tp_api_key": "string",
"rider_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"address":
{
"location_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"longitude": 0,
"latitude": 0
},
"phone": "string",
"funding_source_name": "string",
"space_type": "string",
"home_phone": "string",
"mobile_phone": "string",
"icd_10_codes": "string",
"date_of_birth": "string",
"is_male": true,
"is_Female": true,
"comments": "string",
"private_comments": "string",
"email": "string"
}
]
]

Delete Rider

Delete a single rider/passenger/patient

Request

DELETE	{root_url}/v{version}/riders

Parameter	Type	Description	Notes
api_key	string		REQUIRED
rider_id	string		REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful.
204	No Content
403	The api key used does not have access to this resource.

Get Riders

Get an array of all riders/passengers/patients for a given transportation provider

GET	{root_url}/v{version}/riders

Parameter	Type	Description	Notes
api_key	string		REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Get By MediRoutes Rider ID Endpoint

The following sample response shows what a user would receive back.

[
"Data": [
{
"mediroutes_rider_id": 0,
"tp_api_key": "string",
"rider_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"address":
{
"location_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"longitude": 0,
"latitude": 0
},
"phone": "string",
"funding_source_name": "string",
"space_type": "string",
"home_phone": "string",
"mobile_phone": "string",
"icd_10_codes": "string",
"date_of_birth": "string",
"is_male": true,
"is_Female": true,
"comments": "string",
"private_comments": "string",
"email": "string"
}
]
]

Updating Rider ID using the MediRoutes Rider Id

Update the rider ID by using the MediRoutes rider Id

Request

PATCH	{root_url}/v{version}/riders

Parameter	Type	Description	Notes
api_key	string		REQUIRED
mediroutes_rider_id	int	The rider ID used by MediRoutes	REQUIRED
rider_id	string	The rider ID that you want assigned	REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Expected Response Codes

Code	Description
200	Request was successful.
204	No Content
403	The API key used does not have access to this resource.

Create Rider

Create a new rider/passenger/patient

Request

POST	{root_url}/v{version}/riders

Parameter	Type	Description	Notes
Model	string	See model definition below	REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Model Definition

Parameter	Type	Description	Notes
tp_api_key	string		REQUIRED
rider_id	string	Unique Id for the rider	REQUIRED
first_name	string		REQUIRED
last_name	string		REQUIRED
middle_name	string
address	-
.location_name	string	The name of the location
.address1	string		REQUIRED
.address2	string
.city	string		REQUIRED
.state	string		REQUIRED
.zip	string		REQUIRED
.longitude	float
.latitude	float
phone	string
funding_source_name	string		REQUIRED
space_type	string		REQUIRED
home_phone	string
mobile_phone	string
icd_10_codes	string
date_of_birth	string
is_male	boolean	Undisclosed if both is_male and is_female are false
is_female	boolean	Undisclosed if both is_male and is_female are false
comments	string
private_comments	string
email	string

Expected Response Codes

Code	Description
200	Request was successful.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Create Rider

The following sample response shows what a user would receive back.

[
"Data": [{
"mediroutes_rider_id": 0,
"tp_api_key": "string",
"rider_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"address":
{
"location_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"longitude": 0,
"latitude": 0
},
"phone": "string",
"funding_source_name": "string",
"space_type": "string",
"home_phone": "string",
"mobile_phone": "string",
"icd_10_codes": "string",
"date_of_birth": "string",
"is_male": true,
"is_Female": true,
"comments": "string",
"private_comments": "string",
"email": "string"
}]
]

Update Rider

Update an existing rider/passenger/patient

PUT	{root_url}/v{version}/riders

Parameter	Type	Description	Notes
Model	string	See model definition below	REQUIRED
version	int	API version; currently = "1"	REQUIRED
Authorization	string	bearer {access token}	REQUIRED

Model Definition

Parameter	Type	Description	Notes
tp_api_key	string		REQUIRED
rider_id	string	Unique Id for the rider	REQUIRED
first_name	string		REQUIRED
last_name	string		REQUIRED
middle_name	string
address	-
.location_name	string	The name of the location
.address1	string		REQUIRED
.address2	string
.city	string		REQUIRED
.state	string		REQUIRED
.zip	string		REQUIRED
.longitude	float
.latitude	float
phone	string
funding_source_name	string		REQUIRED
space_type	string		REQUIRED
home_phone	string
mobile_phone	string
icd_10_codes	string
date_of_birth	string
is_male	boolean	Undisclosed if both is_male and is_female are false
is_female	boolean	Undisclosed if both is_male and is_female are false
comments	string
private_comments	string
email	string

Expected Response Codes

Code	Description
200	Request was successful.
403	The API key used does not have access to this resource.

Sample 200 Response Body - Update Rider

The following sample response shows what a user would receive back.

[
"Data": [{
"mediroutes_rider_id": 0,
"tp_api_key": "string",
"rider_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"address":
{
"location_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"longitude": 0,
"latitude": 0
},
"phone": "string",
"funding_source_name": "string",
"space_type": "string",
"home_phone": "string",
"mobile_phone": "string",
"icd_10_codes": "string",
"date_of_birth": "string",
"is_male": true,
"is_Female": true,
"comments": "string",
"private_comments": "string",
"email": "string"
}]
]