{"info":{"_postman_id":"54a8e348-db89-5a2a-02bf-43dc145b7efd","name":"MacroPoint Carrier API","description":"

Last Update: 08/13/2018

The MacroPoint \"Carrier Side\" API allows a carrier to provide:

Location updates in the form of lat/long coordinate sets or complete address
Load event updates as arrival or departure notations
Assignment of a tracking method as cell number, vehicle ID for ELD connection, trailer ID for GPS connection, railcar ID for RFID scan identification and/or rail GPS data

Location updates and event updates can and should be used in conjunction with one another.

Tracking method assignment calls should be used to automatate the process of assigning cell phone numbers to a requesting party's tracking requests in the absence of another data source. If an ELD/GPS connection has already been established by MacroPoint you may automate the assignment of vehicle/trailer IDs via this call as well. Ask your MacroPoint rep about adding these connections.

Authorization

\n\n

Authorization is granted via basic auth - a username and password, concatenated with a colon, base64 encoded. Your MacroPoint activation rep will provide the required username and password at the time of connection.

Example: username:password encoded becomes dXNlcm5hbWU6cGFzc3dvcmQ=

This would be passed in the header as Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

https://www.base64encode.org/

Error Codes

\n\n

Return:

201: Success
400: Bad request
5xx: Server failure

Error Return Example:

<TMSLocationDataResult>\n    <Errors>\n        <Error>\n            <Code>{ErrorCode}</Code>\n            <Message>{Message}</Message>\n        </Error>\n    </Errors>\n</TMSLocationDataResult>\n

\n \n \n \n \n \n \n \n \n \n \n \n \n

Error Code	Description
1000	All argument/domain-rule validation exceptions
9999	Unexpected error occurred – Administrator notified

\n\n

Calls

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorization","slug":"authorization"},{"content":"Error Codes","slug":"error-codes"},{"content":"Calls","slug":"calls"}],"owner":"4593392","collectionId":"54a8e348-db89-5a2a-02bf-43dc145b7efd","publishedId":"RWEcRgiW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-08-13T20:51:48.000Z"},"item":[{"name":"Location Update","event":[{"listen":"test","script":{"id":"6277ebec-7495-46a0-9d7b-e9c4a02a1c19","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8a48dd87-df0e-40b0-adaa-2c0323406a74","exec":["var carriers = {}","","carriers[\"5507396\"] = { ","//Name and API credentials"," MPID: \"5507396\", "," Name: \"TEST: MacroPoint Carrier\","," Username: \"5507396\", "," Password: \"ABC123\", ","//Sender identifiers"," SenderLoadID: \"DocumentTest2\","," VehicleID: \"veh1\",","//Requestor identifiers"," RequestorMPID: \"1107351\","," RequestorLoadID: \"DocumentTest2\","," AllowAccessMPID: \"1107351\",","//Location"," Latitude: \"45.517500\","," Longitude: \"-122.680077\","," Uncertainty: \"\","," CreatedDateTime: \"2018-07-05T21:42Z\","," AddLine1: \"\","," AddLine2: \"\","," City: \"\","," State: \"\","," PostalCode: \"\","," CountryCode: \"\",","","}","","var carrier = carriers[\"5507396\"];","","pm.variables.set(\"SenderLoadID\", carrier.SenderLoadID);","pm.variables.set(\"VehicleID\", carrier.VehicleID);","pm.variables.set(\"RequestorMPID\", carrier.RequestorMPID);","pm.variables.set(\"RequestorLoadID\", carrier.RequestorLoadID);","pm.variables.set(\"AddLine1\", carrier.AddLine1);","pm.variables.set(\"AddLine2\", carrier.AddLine2);","pm.variables.set(\"City\", carrier.City);","pm.variables.set(\"State\", carrier.State);","pm.variables.set(\"PostalCode\", carrier.PostalCode);","pm.variables.set(\"CountryCode\", carrier.CountryCode);","pm.variables.set(\"MacroPointStopID\", carrier.MacroPointStopID);","pm.variables.set(\"CompleteDateTime\", carrier.CompleteDateTime);","pm.variables.set(\"AllowAccessMPID\", carrier.AllowAccessMPID);","pm.variables.set(\"Latitude\", carrier.Latitude);","pm.variables.set(\"Longitude\", carrier.Longitude);","pm.variables.set(\"Uncertainty\", carrier.Uncertainty);","pm.variables.set(\"CreatedDateTime\", carrier.CreatedDateTime);","pm.variables.set(\"Username\", carrier.Username);","pm.variables.set(\"Password\", carrier.Password);","","console.log(\"setting variables for [\" + carrier.MPID + \"] \" + carrier.Name);"],"type":"text/javascript"}}],"id":"25002fe9-7dc1-3f5a-d44a-674e534ecf69","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n \n \n

\n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/location","description":"

Field Descriptions

Fields in bold are required. You may pass a coordiante set or a complete address. You do not need both.

Sender

LoadID: How the load is identified in your TMS/database
VehicleID: The ID of the vehicle that is/will be assigned

Requestor

MPID: The MacroPoint ID of the customer requesting visibility from you
LoadID: What your customer is using to identify their tracking session within MacroPoint

AllowAccessFrom

MPID: The MacroPoint ID of the customer requesting visibility from you once again

Location

Latitude: Latitude in decimal degrees
Longitude: Longitude in decimal degrees

Address line 1/line2: Street name and number
City: City, may be abbreviated
StateOrProvince: State, may be abbreviated
PostalCode: Postal code of current location
CountryCode: In ISO 3166-1 alpha-2 or alpha-3, example: US or USA
Uncertainty: Radius in miles of the area of uncertainty of the location fix. This value is an indication of the quality of the fix. A smaller radius indicates a lower degree of uncertainty about the actual location of the device.
CreatedDateTime: The time of the location polling in ISO 8601 UTC format. Example: 2018-11-04T19:25Z or 2018-11-04T19:25:30Z

\n","urlObject":{"protocol":"https","path":["api","1.0","tms","data","location"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"02d3ee28-1065-470f-ace4-d076d33f94d9","name":"Old location rejection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/location"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"360","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/xml; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 03 Jul 2018 21:39:44 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"1000Created DateTime 2018-06-12T19:35Z cannot be more than 2880 minutes in the past.Unknown"},{"id":"0d160426-0f9b-4b62-ae42-f09a68e8a15f","name":"Credentials incorrect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/location"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Date","value":"Thu, 05 Jul 2018 21:49:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"WWW-Authenticate","value":"Basic realm=\"MacroPoint\"","name":"WWW-Authenticate","description":"Indicates the authentication scheme that should be used to access the requested entity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":""},{"id":"e5fc2ad1-2a3e-439a-983d-0e549bd0fe05","name":"Successful location update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/location"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Date","value":"Thu, 05 Jul 2018 21:44:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"25002fe9-7dc1-3f5a-d44a-674e534ecf69"},{"name":"Event Update","event":[{"listen":"test","script":{"id":"65672d94-41c5-4e9d-af22-f2b261416336","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f67998b2-9a5d-4293-91a8-94e18e31e335","exec":["var carriers = {}","","carriers[\"5507396\"] = { ","//Name and API credentials"," MPID: \"5507396\", "," Name: \"TEST: MacroPoint Carrier\","," Username: \"5507396\", "," Password: \"ABC123\", ","//Sender identifiers"," SenderLoadID: \"DocumentTest2\",","//Requestor identifiers"," RequestorMPID: \"1107351\","," RequestorLoadID: \"DocumentTest2\","," AllowAccessMPID: \"1107351\",","//Stop Address"," StopName: \"McDonald's\","," StopType: \"Pickup\","," AddLine1: \"1035 SW 6th Ave\","," AddLine2: \"\","," City: \"Portland\","," State: \"OR\","," PostalCode: \"97204\","," CountryCode: \"USA\",","//Stop Information"," StartDateTime: \"\","," EndDateTime: \"\","," SequenceNumber: \"1\","," StopID: \"\","," Notes: \"test\","," MacroPointStopID: \"\","," EventName: \"Arrived\","," CompleteDateTime: \"2018-07-05T21:42Z\",",""," }","","var carrier = carriers[\"5507396\"];","","pm.variables.set(\"SenderLoadID\", carrier.SenderLoadID);","pm.variables.set(\"RequestorMPID\", carrier.RequestorMPID);","pm.variables.set(\"RequestorLoadID\", carrier.RequestorLoadID);","pm.variables.set(\"StopName\", carrier.StopName);","pm.variables.set(\"StopType\", carrier.StopType);","pm.variables.set(\"AddLine1\", carrier.AddLine1);","pm.variables.set(\"AddLine2\", carrier.AddLine2);","pm.variables.set(\"City\", carrier.City);","pm.variables.set(\"State\", carrier.State);","pm.variables.set(\"PostalCode\", carrier.PostalCode);","pm.variables.set(\"CountryCode\", carrier.CountryCode);","pm.variables.set(\"StartDateTime\", carrier.StartDateTime);","pm.variables.set(\"EndDateTime\", carrier.EndDateTime);","pm.variables.set(\"SequenceNumber\", carrier.SequenceNumber);","pm.variables.set(\"StopID\", carrier.StopID);","pm.variables.set(\"Notes\", carrier.Notes);","pm.variables.set(\"MacroPointStopID\", carrier.MacroPointStopID);","pm.variables.set(\"EventName\", carrier.EventName);","pm.variables.set(\"CompleteDateTime\", carrier.CompleteDateTime);","pm.variables.set(\"AllowAccessMPID\", carrier.AllowAccessMPID);","pm.variables.set(\"Username\", carrier.Username);","pm.variables.set(\"Password\", carrier.Password);","","console.log(\"setting variables for [\" + carrier.MPID + \"] \" + carrier.Name);"],"type":"text/javascript"}}],"id":"2cb0a9cc-1d6c-567f-47e9-b5dec417a9ac","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n \n \n

\n \n \n \n \n \n \n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/stopevent","description":"

Field Descriptions

Fields in bold are required.

Sender

LoadID: How the load is identified in your TMS/database
VehicleID: The ID of the vehicle that is/will be assigned

Requestor

MPID: The MacroPoint ID of the customer requesting visibility from you
LoadID: What your customer is using to identify their tracking session within MacroPoint

Stop

Name: The name you would like to give the stop. Max 64 characters
StopType: Should be \"PickUP\" or \"DropOff\"
Address line 1/line2: Street name and number
City: City, may be abbreviated
StateOrProvince: State, may be abbreviated
PostalCode: Postal code of current location
CountryCode: In ISO 3166-1 alpha-2 or alpha-3, example: US or USA
StartDateTime/EndDateTime: Should be in IS0 8601 UTC Format\na. E.g. 2014-11-04T19:25Z or 2014-11-04T19:25:30Z
SequenceNumber: The sequence of the stop in the tripsheet
Notes: Any notes relevant to the stop
StopID: The stop ID used internally by your TMS system
MacroPointStopID: A reference ID passed by MacroPoint to you in a previous call, identifying the stop

Event

Name: Should be \"Arrived\" or \"Departed\"
CompletedDateTime: The time this event was completed at the stop in ISO 8601 UTC format. Example: 2018-11-04T19:25Z or 2018-11-04T19:25:30Z
FormItem: Used for custom form information. Node can be repeated as many times as there are form values to be\nsubmitted/updated.

\n","urlObject":{"protocol":"https","path":["api","1.0","tms","data","stopevent"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"5f815cc4-74d4-4dfc-bb4a-c5b09f1a43be","name":"Successful event update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n

\n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/stopevent"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Date","value":"Thu, 05 Jul 2018 21:42:48 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":""},{"id":"af0631ca-9038-4d1f-8ded-8bd089524302","name":"Old event rejection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","disabled":false}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n

\n \n \n \n \n \n \n"},"url":"https://macropoint-lite.com/api/1.0/tms/data/stopevent"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"344","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/xml; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 03 Jul 2018 21:56:38 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"1000Event CompletedDateTime cannot be more than 24 hours in the pastFatal"}],"_postman_id":"2cb0a9cc-1d6c-567f-47e9-b5dec417a9ac"},{"name":"Tracking Assignment","event":[{"listen":"prerequest","script":{"id":"4727a1c8-b818-4688-8097-f90a2ef86c60","exec":["var carriers = {}","","carriers[\"5507396\"] = { ","//Name and API credentials"," MPID: \"5507396\", "," Name: \"TEST: MacroPoint Carrier\","," Username: \"5507396\", "," Password: \"ABC123\", ","//Requestor identifiers"," RequestorMPID: \"1107351\","," RequestorLoadID: \"DocumentTest2\",","//Number Typer and Tracking Number"," NumberType: \"\","," TrackingNumner: \"\",","","}","","var carrier = carriers[\"5507396\"];","","pm.variables.set(\"RequestorMPID\", carrier.RequestorMPID);","pm.variables.set(\"RequestorLoadID\", carrier.RequestorLoadID);","pm.variables.set(\"Username\", carrier.Username);","pm.variables.set(\"Password\", carrier.Password);","pm.variables.set(\"NumberType\", carrier.NumberType);","pm.variables.set(\"TrackingNumber\", carrier.TrackingNumber);","","console.log(\"setting variables for [\" + carrier.MPID + \"] \" + carrier.Name);"],"type":"text/javascript"}}],"id":"5b77d45f-4e06-4bf2-b6bf-9bb1a5ecef2a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n\t\r\n\t\r\n \r\n"},"url":"https://macropoint-lite.com/api/1.0/order/trackingnumberassignment","description":"

Field Descriptions

Fields in bold are required.

Tracking method assignment

Number Type: \"type\" should be Mobile, MacroPoint, ShipmentID, or VehicleID

TrackingNumber: Formatting is based on the \"type\" used:\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n

Type	Description	TrackingNumber Example
Mobile	cellphone number	1234567890 without any formatting characters
MacroPoint	12 character alpha-numeric sequence	12C3GHTR154Y
ShipmentID	carrier/customer TMS load ID	BOL-123548123
VehicleID	Truck/Trailer ID as used by the carrier's ELD/GPS provider	Bill Williams - 17, Trailer 5, D3476

Requestor

MPID: The MacroPoint ID of the customer requesting visibility from you
LoadID: What your customer is using to identify their tracking session within MacroPoint

\n","urlObject":{"protocol":"https","path":["api","1.0","order","trackingnumberassignment"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b77d45f-4e06-4bf2-b6bf-9bb1a5ecef2a"}],"event":[{"listen":"prerequest","script":{"id":"28453bfe-ebed-4218-bb33-d429205a3a02","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"758693d5-6abc-4c38-83fd-c5036b02f965","type":"text/javascript","exec":[""]}}],"variable":[{"key":"SenderLoadID","value":""},{"key":"VehicleID","value":""},{"key":"RequestorMPID","value":""},{"key":"RequestorLoadID","value":""},{"key":"StopName","value":""},{"key":"StopType","value":""},{"key":"AddLine1","value":""},{"key":"AddLine2","value":""},{"key":"City","value":""},{"key":"State","value":""},{"key":"PostalCode","value":""},{"key":"CountryCode","value":""},{"key":"StartDateTime","value":""},{"key":"EndDateTime","value":""},{"key":"SequenceNumber","value":""},{"key":"StopID","value":""},{"key":"Notes","value":""},{"key":"MacroPointStopID","value":""},{"key":"EventName","value":""},{"key":"CompleteDateTime","value":""},{"key":"AllowAccessMPID","value":""},{"key":"Latitude","value":""},{"key":"Longitude","value":""},{"key":"Uncertainty","value":""},{"key":"Username","value":""},{"key":"Password","value":""},{"key":"CreatedDateTime","value":""},{"key":"NumberType","value":""},{"key":"TrackingNumber","value":""}]}