Project Overview
\nVerida has developed an Application Programming Interface (API) for internal and external fleet management. Dispatching partners can now integrate their routing software with Verida's API.
\nBenefits
\nThe Third Party API will allow us to integrate with dispatching partners more easily. We can use this integration to retrieve the vehicle’s heartbeat data directly from their systems. Having the heartbeat data will allow us to publish “Where’s my ride?” details across all Verida's portals.
The integration will also improve claims submission efficiency allowing for a more accurate data capture.
How Does It Work?
\nWe provide the dispatching partner the log in information to get required authentication token.
\nSubmitter Ids are used to distinguish between each provider you service. We offer an api call to get your providers with their submitter id.
\nWe require all vehicles be in our system. We offer an api call to get the available vehicles.
\nWe require all drivers be in our system. We offer an api call to get the available drivers.
\nThis is how you get the bearer token you will use to gain access to the other api calls.
\n","urlObject":{"path":["api","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"78090a86-2af2-4570-b225-46aa2a846b45","name":"Token Request Valid Result","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\" : \"username\",\r\n\"password\" : \"password\",\r\n\"grant_type\" : \"token_request\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/token"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 15:27:57 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"9d302298-6891-4b1d-af34-d0357ae23dfd\",\r\n \"auth_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ3aW5neiIsImp0aSI6IjIxYTBlZTQzLWU2MTItNDczNC05Y2UyLWQxZDMwYzExOGFlNCIsImlhdCI6MTY1OTYyNjg3OCwicm9sIjoiYXBpX2FjY2VzcyIsImlkIjoiOWQzMDIyOTgtNjg5MS00YjFkLWFmMzQtZDAzNTdhZTIzZGZkIiwidXNlck5hbWUiOiJ3aW5neiIsIlRoaXJkUGFydHlJZCI6IjEiLCJuYmYiOjE2NTk2MjY4NzgsImV4cCI6MTY1OTY0MTI3OCwiaXNzIjoid2ViQXBpIiwiYXVkIjoiVGhpcmRQYXJ0eVVzZXIifQ.UMhcixHQ3g87iGyIBLh44uqQjTzXeQLtIXtGc96ZDHk\",\r\n \"expires_in\": 14400\r\n}"}],"_postman_id":"9f888275-ee74-4d4e-ac05-05090812de94"}],"id":"29843ed1-be5b-4f8b-b0da-1f672295d2d4","description":"Authorization is OAuth v2 Token based in the authorization header. This token will be passed in the header with all future request. Expires after 24 hours.
\n","_postman_id":"29843ed1-be5b-4f8b-b0da-1f672295d2d4"},{"name":"Events","item":[{"name":"Heartbeat","id":"7f2b1478-18ed-4f42-81e5-0e14979483a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Heartbeat post the current location for each driver. This is a required event.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","heartbeat"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"1958aef5-47d4-40d3-b0a5-5c2413cf4b16","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/heartbeat"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7f2b1478-18ed-4f42-81e5-0e14979483a5"},{"name":"OnWay","id":"3347697f-2ec8-4905-a800-677a103d3a8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{myToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventDate_UTC\": \"2022-08-04T16:41:00.825Z\",\r\n \"latitude\": 37.0902,\r\n \"longitude\": -95.7129,\r\n \"driverId\": 0,\r\n \"vehicleId\": 0,\r\n \"tripLegId\": 123456,\r\n \"estimatedArrivalTime_UTC\": \"2022-08-04T16:46:04.305Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{url}/api/v1.0/{submitterId}/event/onway","description":"OnWay allows us know that the driver is on their way to pick up the member. This will be a required event that will allow us to alert member their ride is on the way.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","onway"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"f2fed6da-2b2d-461a-a9d0-af45b9874cb1","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/onway"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3347697f-2ec8-4905-a800-677a103d3a8b"},{"name":"Cancel","id":"f2ff13a0-44b5-4e21-9711-8f7e39eba613","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{myToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cancelTypeId\": 0,\r\n \"tripLegId\": 123456\r\n}","options":{"raw":{"language":"json"}}},"url":"{url}/api/v1.0/{submitterId}/event/cancel","description":"Cancel allows the driver to cancel a trip and give the Canel Reason.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","cancel"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"7acf1777-48f6-47ef-95c8-827d1b44431c","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/cancel"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f2ff13a0-44b5-4e21-9711-8f7e39eba613"},{"name":"Pick Up Arrived","id":"9a980b46-6f45-4795-847a-08e1bc03a5b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"PickUp Arrival alerts us that the driver is at the location to pick up the member. It is a required event.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","pickup"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"11ec4ebc-4c12-453a-abc0-0bdbca383b97","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/pickup"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9a980b46-6f45-4795-847a-08e1bc03a5b4"},{"name":"Pick Up Complete","id":"11e37108-1395-4aed-9c6c-7b71f03e9cf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Pick Up Complete alerts that the driver has successfully picked up the member. This is not a required event and will be used to (along with Pick Up Arrived) to determine if the correct pick up location happened.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","pickup","completed"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"39aa0657-568d-421d-aeb4-547af6331332","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/pickup/completed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"11e37108-1395-4aed-9c6c-7b71f03e9cf4"},{"name":"Pick Up Member No Show","id":"c76447e8-d1a4-4ecc-85d6-a046d3c12c87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"No Show lets us know that the member did not get a ride from the driver because the rider was not ready or no longer needed the ride. This event must happen at the pick up location.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","pickup","NoShow"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"353604fb-34cd-4174-9695-c5c939457147","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/pickup/noshow"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c76447e8-d1a4-4ecc-85d6-a046d3c12c87"},{"name":"Drop Off Arrived","id":"52bbacc6-5ea6-4acf-abc0-2b81259cd066","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Drop Off Arrival lets us know the driver is at the drop off location. This is required event.
\nMemberSignature is not required, but must be used in one of the drop off events.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","dropoff"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"9934e168-1c87-45a9-b0f0-ca92c6d68a7b","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/dropoff"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"52bbacc6-5ea6-4acf-abc0-2b81259cd066"},{"name":"Drop Off Complete","id":"8f607957-8fd3-483c-8a93-f88900cb4b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Drop Off Completed lets us know the driver has completed the trip and dropped off the member. . This is not a required event but can be used to determine (along with drop off arrived) if a drop off was at the correct location/time.
\nMemberSignature is not required, but must be used in one of the drop off events.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","dropoff","completed"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"8827a3b9-6811-4292-ae6b-1cda8593f177","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/event/dropoff/completed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8f607957-8fd3-483c-8a93-f88900cb4b73"},{"name":"Sign In","id":"8fc04851-65b1-4df6-9498-35352ca52590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Sign In allows the driver to report the vehicle they will be using for the day and also give their signature. This is only needed once a day.
\n","urlObject":{"path":["api","v1.0","{submitterId}","event","signin"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"354fcef2-27f4-4418-a57b-677440b13c79","name":"Result","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"latitude\": 37.0902,\r\n \"longitude\": -95.7129,\r\n \"driverId\": 0,\r\n \"vehicleId\": 0,\r\n \"driverSignature\" : \"URL or base 64\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{url}/api/v1.0/{submitterId}/event/signin"},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8fc04851-65b1-4df6-9498-35352ca52590"},{"name":"New Request","id":"1828234d-9e7f-40b2-8c2a-c5bd5ce450cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1828234d-9e7f-40b2-8c2a-c5bd5ce450cc"}],"id":"d30183c5-bfe4-4314-9220-f5fab7886c6e","description":"These are the events that we current support. The only two required are pick up complete and drop off complete. Pick Up Arrival, Drop Off Arrival, No Show are all optional but if available will be used for determining if valid trip.
\n","_postman_id":"d30183c5-bfe4-4314-9220-f5fab7886c6e"},{"name":"Drivers","item":[{"name":"Get Drivers","id":"6c344413-537c-4fb8-a28c-e421ecf50b03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get Drivers is responsible for getting all of the drivers for a particular provider
\n","urlObject":{"path":["api","v1.0","{submitterId}","drivers"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"a14897ff-b2f6-4341-b3a3-9c7100b65062","name":"Result","originalRequest":{"method":"GET","header":[],"url":"{url}/api/v1.0/{submitterId}/drivers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:27:49 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"driverId\": 11,\n \"providerId\": 12,\n \"driverUserName\": \"driver1\",\n \"lastName\": \"Smith\",\n \"firstName\": \"Teddy\",\n \"submitterId\": \"GA00001\",\n \"driverLicenseNumber\": \"123456789\",\n \"effectiveDate\": \"2022-03-23T00:00:00+00:00\",\n \"isActive\": true\n },\n {\n \"driverId\": 15,\n \"providerId\": 12,\n \"driverUserName\": \"driver2\",\n \"lastName\": \"Jones\",\n \"firstName\": \"Matt\",\n \"submitterId\": \"GA00001\",\n \"driverLicenseNumber\": \"987654321\",\n \"effectiveDate\": \"2022-07-26T00:00:00+00:00\",\n \"isActive\": false\n }\n]"}],"_postman_id":"6c344413-537c-4fb8-a28c-e421ecf50b03"}],"id":"a4c7cd8e-61bb-43b6-b6b6-6b57d9ccf13f","description":"We require all drivers be in our system and these calls deal with getting driver info. We use driver Id in the api calls to track the driver for an event.
\n","_postman_id":"a4c7cd8e-61bb-43b6-b6b6-6b57d9ccf13f"},{"name":"Options","item":[{"name":"Get No Show Options","id":"845547e8-b954-4eee-9f6d-d24ccaa7962b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets list of available No Show options
\n","urlObject":{"path":["api","v1.0","{submitterId}","options","NoShow"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"e5503485-0def-498f-8e25-17ae24f9a20f","name":"Result","originalRequest":{"method":"GET","header":[],"url":"{url}/api/v1.0/{submitterId}/Options/NoShow"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:27:49 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"value\": 0,\n \"name\": \"NoClient\"\n },\n {\n \"value\": 1,\n \"name\": \"NotReady\"\n },\n {\n \"value\": 2,\n \"name\": \"NotReadyWillReturn\"\n },\n {\n \"value\": 3,\n \"name\": \"DeniedByDriver\"\n }\n]"}],"_postman_id":"845547e8-b954-4eee-9f6d-d24ccaa7962b"},{"name":"Get Cancel Options","id":"6356b6c0-5826-440e-b796-4767399d2989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets list of available Cancel options
\n","urlObject":{"path":["api","v1.0","{submitterId}","options","Cancel"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"03f90ac1-f5b9-477d-9088-34aee911d4de","name":"Result","originalRequest":{"method":"GET","header":[],"url":"{url}/api/v1.0/{submitterId}/Options/Cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:27:49 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"value\": 1,\n \"name\": \"NoClient\"\n },\n {\n \"value\": 2,\n \"name\": \"CancelAtDoor\"\n },\n {\n \"value\": 3,\n \"name\": \"NotReady\"\n },\n {\n \"value\": 4,\n \"name\": \"AdminCancel\"\n },\n {\n \"value\": 5,\n \"name\": \"NotReadyWillReturn\"\n },\n {\n \"value\": 6,\n \"name\": \"DeniedByDriver\"\n }\n]"}],"_postman_id":"6356b6c0-5826-440e-b796-4767399d2989"}],"id":"613218f6-a605-4e0b-81f9-fa66beceb247","description":"Returns list of possible options for No SHow and Cancel
\n","_postman_id":"613218f6-a605-4e0b-81f9-fa66beceb247"},{"name":"Providers","item":[{"name":"Get Providers","id":"bb1e2776-2234-4388-a2b8-2b10c2d375f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets a list of providers available for the third-party company
\n","urlObject":{"path":["api","v1.0","providers"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"eae86f7d-90da-4f44-8bdb-92f9dbf2a202","name":"Result","originalRequest":{"method":"GET","header":[],"url":"{url}/api/v1.0/providers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"325"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:35:43 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"DatasourceId\": 2,\n \"ProviderName\": \"Company 1\",\n \"SubmitterId\": \"GA00987\",\n \"ProviderId\": 987\n },\n {\n \"DatasourceId\": 4,\n \"ProviderName\": \"Company 2\",\n \"SubmitterId\": \"TN00382\",\n \"ProviderId\": 382\n },\n {\n \"DatasourceId\": 2,\n \"ProviderName\": \"Company 3\",\n \"SubmitterId\": \"GA00790\",\n \"ProviderId\": 790\n }\n \n]"}],"_postman_id":"bb1e2776-2234-4388-a2b8-2b10c2d375f2"}],"id":"1f69271e-077d-4ff3-99b9-6023b7c23309","description":"These are calls a third-party company will make to get information about the providers that they have under contract. The \"SubmitterId\" is the key we use to know which provider they are attempting to post data to. It will be used in the url anywhere {submitterId} is shown.
\n","_postman_id":"1f69271e-077d-4ff3-99b9-6023b7c23309"},{"name":"Vehicles","item":[{"name":"Get Vehicles","id":"44e324ea-929e-4178-8cef-fe5653b86a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets a list of all of the vehicles for a particular provider
\n","urlObject":{"path":["api","v1.0","{submitterId}","vehicle"],"host":["{url}"],"query":[],"variable":[]}},"response":[{"id":"a90a26ea-d50d-46ca-896a-66930328c27e","name":"Result","originalRequest":{"method":"GET","header":[],"url":"{url}/api/v1.0/{submitterId}/vehicle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"vehicleId\": 10,\n \"year\": 2000,\n \"make\": \"Acura\",\n \"model\": \"Integra\",\n \"tagNumber\": \"AAA99999\",\n \"vin\": \"1FTCR15XXRTB03260\",\n \"submitterId\": \"GA00012\",\n \"providerId\": 12,\n \"datasourceId\": 99,\n \"isActive\": true,\n \"effectiveDate\": \"2022-03-23T00:00:00+00:00\"\n },\n {\n \"vehicleId\": 16,\n \"year\": 2001,\n \"make\": \"Acura\",\n \"model\": \"Integra\",\n \"tagNumber\": \"ZZZ9999\",\n \"vin\": \"JH4DB1542MS007683\",\n \"submitterId\": \"GA00012\",\n \"providerId\": 12,\n \"datasourceId\": 99,\n \"isActive\": false,\n \"effectiveDate\": \"2022-07-26T00:00:00+00:00\"\n }\n]"}],"_postman_id":"44e324ea-929e-4178-8cef-fe5653b86a46"}],"id":"68ccd1f2-affb-433d-979c-860f3b0fdf89","description":"We require all vehicles be in our system and these calls deal with getting vehicle info. We use the vehicle Id in the api calls to track the vehicle for an event.
\n","_postman_id":"68ccd1f2-affb-433d-979c-860f3b0fdf89"},{"name":"Trips For Provider","item":[{"name":"Trips For Provider","id":"febd5982-e0b4-4b12-87e3-ba0aac212d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets a list of all of the trips from a provider for a particular day. We currently only support getting trips for one provider for one day.
\n","urlObject":{"path":["api","v1.0","{submitterId}","trips","byDate"],"host":["{url}"],"query":[{"key":"startDate","value":"8/11/2022"},{"key":"endDate","value":"8/12/2022"}],"variable":[]}},"response":[{"id":"5d243a68-dbd4-45d5-8404-6f8ac2ee0e5b","name":"Result","originalRequest":{"method":"POST","header":[],"url":"{url}/api/v1.0/{submitterId}/trips/byDate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 04 Aug 2022 16:37:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Set-Cookie","value":"ARRAffinity=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d0cd888619ba46550a7f867de3f4826882610ac4e59f52608415db362753138a;Path=/;HttpOnly;SameSite=None;Secure;Domain=setithirdparty-sandbox.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n{\n \"tripLegId\" : 12345,\n \"status\" : \"scheduled\",\n \"leg\" : \"A\",\n \"memberId\" : \"GA1111111\",\n \"memberName\" : \"Tom Smith\",\n \"firstName\" : \"Tom\",\n \"lastName\" : \"Smith\",\n \"escorts\" : 0,\n \"attendants\" : 1,\n \"carSeats\" : 0,\n \"boosterSeats\" : 0,\n \"infantSeats\" : 0,\n \"appointmentReason\" : \"Dr Office Visit\",\n \"willCall\" : false,\n \"mobilityType\" : \"ambulatory\",\n \"pickUpTime\" : \"2022-04-23T18:25:43.511Z\",\n \"dropOffTime\" : \"2022-05-23T18:25:43.511Z\",\n \"pickUpLocation\" : {\n \"latitude\" : 33.333333,\n \"longitude\" : 33.33333,\n \"address1\" : \"123 Elm Street\",\n \"address2\" : \"\",\n \"suite\" : \"\",\n \"city\" : \"anytown\",\n \"state\" : \"GA\",\n \"zip\" : \"00000\",\n \"notes\" : \"Home address is...\",\n \"phone\" : \"4044444444\"\n },\n \"dropOffLocation\" : {\n \"latitude\" : 33.333333,\n \"longitude\" : 33.33333,\n \"address1\" : \"123 Elm Street\",\n \"address2\" : \"\",\n \"suite\" : \"\",\n \"city\" : \"anytown\",\n \"state\" : \"GA\",\n \"zip\" : \"00000\",\n \"notes\" : \"Look at back of building...\",\n \"phone\" : \"4044444444\"\n\n }\n}\n\n]"}],"_postman_id":"febd5982-e0b4-4b12-87e3-ba0aac212d41"}],"id":"5089ff33-ac5b-4863-b539-f3939171ca14","_postman_id":"5089ff33-ac5b-4863-b539-f3939171ca14","description":""}]}