Use this request to retrieve the entire MoversConnect order object for a provided primary key and data type.
Request Format
https://{server}/api/orders/{prikey}?datatypemapname={datatypemapname}
Request Parameters
The following table describes the parameters available for the Full Order Information Request.
|
Parameter |
Description |
|
{server} |
Provide the name of the server running the API Service. |
|
{prikey} |
Provide the Orders.PriKey of the record you wish to retrieve through this request. Locate an Orders.PriKey based on Order Number through the Find Order Request. |
|
{datatypemapname} |
Provide the name of the record type to process. This argument affects which codes return with the order information, such as those for Salesperson ID, Commodity Code, Shipment Status Code, etc.) The API Service matches on a Name value defined within the XML System Data Type Map section within XML System Setup (which also identifies the corresponding XML Interface Setup record and van line affiliation). For example, you may wish to retrieve data for a SIRVA order and reference “Sirva Order Information” defined within XML System Setup.
Technical Reference The database fields referenced by this argument include the following: XmlInterface.XmlInterfaceID XmlSystem.XmlInterfaceFID XmlSystemDataTypeMap.Name
|
Request Return
Upon a successful call, the request returns entire MoversConnect order object in XML or JSON format.
Upon an error, the request returns an error code along with an error description. In the example below, the API Service was unable to locate an order based on the information provided.
{"ErrorCode":999999,"Issue":"MssOrderID: 72-1-2 not found."}
Example
Request to retrieve order information for a primary key of “1092” for the data mapping of “UniGroup Order Information – Registration”.
https://appserv:9999/api/orders/1092?datatypemapname=UniGroup%20Order%20Information%20-%20Registration
Returns: MoversConnect order object:
{"Addresses":[{"Address1":"120 Elm Ave","City":"Granby","Country":"USA","CountryName":"United States of America","Postal":"80446","State":"CO","Type":"ORIG"},{"Address1":"9023 Parker, Suite A","City":"Boulder","Country":"USA","CountryName":"United States of America","Postal":"80304","State":"CO","Type":"DEST"}],"Agents":[{"AgentID":"U00000","AgentName":"EWS Moving Systems","Type":"BOOK","VanLineID":"U"},{"AgentID":"U0066","AgentName":"Rossiter Relocation","Type":"HAUL","VanLineID":"U"},{"AgentID":"U0022","AgentName":"Mesa Systems, Inc","Type":"ORIG","VanLineID":"U"},{"AgentID":"U0054","AgentName":"East End Transfer & Storage","Type":"DEST","VanLineID":"U"},{"AgentID":"U9999","AgentName":"The Big Move","Type":"BRAN","VanLineID":"U"}],"AssignedOn":"2014-03-20","Commodity":"HHG","DateQueued":"\/Date(1454689344723)\/","DelvActual":"2015-06-18","DelvEarly":"2014-03-20","DelvLate":"2014-03-25","EMail":"bsmith@aegis.com","ETA":"2014-03-20","EstimatedWeight":5000,"FirstName":"Bob","IsFullOrderDownload":true,"IsFullOrderDownloadSupported":true,"LastName":"Smith","LoadActual":"2014-04-18","LoadEarly":"2014-03-19","LoadLate":"2014-03-20","Military":{"DestinationBaseCode":"LHAT","GblNumber":"BKMT0000999","SsnNumber":"XXX-XX-9999"},"OrderNumber":{"MssOrderID":1092,"OrderSeg":"72-1-2","VanLineID":"U","XmlSystemDataTypeMapName":"UniGroup Order Information - Registration"},"PackEarly":"2014-03-18","PackLate":"2014-03-18","Phones":[{"Area":"456","Country":"USA","Local":"789-1321","Ranking":null,"Type":"ORIGHOME"},{"Area":"587","Country":"USA","Local":"699-8713","Ranking":null,"Type":"ORIGWORK"},{"Area":"789","Country":"USA","Local":"456-1234","Ranking":null,"Type":"DESTHOME"},{"Area":"488","Country":"USA","Local":"712-3567","Ranking":null,"Type":"DESTWORK"}],"ShipmentStatus":"Loaded","ShipmentType":"C","Source":"MMS","UtcOffset":-420}