The following table lists the MoversSuite setup needed to support Agent API. A setup example displays below this table.
|
NOTES |
|
The MSSApiService specific to each customer be running in order to process Agent API service requests. |
|
To view commands, exceptions, and other data regarding the Agent API service, turn on MssApiService Logging. |
|
Setup Area |
Description | ||||||||
|
Refer to the data within this setup area for assistance in updating and adding records through the Agent API service. The warnings and errors returned when adding and updating records within this setup are similar to those encountered through the Agent API.
Fields in this setup area are referenced by all Agent API Methods.
The following table lists key Agent Setup fields referenced by Agent API process.
| |||||||||
|
Refer to the data within this setup area for assistance in updating and adding records through the Agent API service. The warnings and errors returned when adding and updating records within this setup are similar to those encountered through the Agent API.
Fields in this setup area are referenced by all Agent API Methods.
The following table lists key Agent Market Setup fields referenced by Agent API process.
| |||||||||
|
View and manage agent records through this tab in MoversSuite. | |||||||||
|
Identify the van line data associated to the Agent Setup record.
The following table lists key Van Line Setup fields referenced by Agent API process.
The Van Line assigned to the Agent API record (Agent Setup) must have a Van Line Code that matches to the External Code set for the XML Interface Setup record also assigned to the Agent API through the VanLineCode property. | |||||||||
|
Define the interface that supports Agent API. The VanLineCode associated to the Agent API must be defined as an External Code within this record. This records also links to the XML System Setup record by the Interface.
| |||||||||
|
Use this setup to create the System property utilized by Agent API. Specifically the External System setting will match what is set for the External System in this setup.
|
SETUP EXAMPLE
|
Setup Area |
Example Settings |
Agent API Property |
|
Agent ID: “U1234” Name: “EWS Movings Systems” Van Line: “UniGroup” Vendor ID: “EWS Moving” |
AgentID Name
VendorID | |
|
Van Line Code: “U” Van Line Name: “United Van Lines” |
| |
|
Vendor Name: “UniGroup” Van Line Item: “United Van Lines” and External Code: “U” |
VanLineCode | |
|
Interface: “UniGroup” External System: “UniGroup Queues” |
System |