This section lists the methods available through the Agent API service, which is sub-process of the MoversSuite API Service.
The URL examples that use the GET, PUT, and POST HTTP verbs can be used via an Internet browser, such as Microsoft Internet Explorer, Mozilla FireFox, Google Chrome, etc. Enter the specified URL with appropriate parameters and server and the browser will process the request.
The following table summarizes the methods available for the Agent API service.
|
Agent API Method |
Description |
|
Retrieves an agent record by the Agent ID or unique database identifier. | |
|
Add an agent record to MoversSuite. These markets are stored within the Agent table and accessible through Agent Market Setup. | |
|
Update a MoversSuite agent record. | |
|
The following methods are specific to the Agent Market records. | |
|
Retrieve all market records. These are markets that agents can be assigned to. | |
|
Add an Agent Market record. These markets are stored within the AgentMarket table and accessible through Agent Market Setup. | |
|
Remove an Agent Market record. | |
|
Update an Agent Market record. | |
|
Assign an Agent to a known Agent Market record by providing the primary key to the Agent and the External Code associated to the Agent Market. | |
|
Remove an Agent Market from an Agent record by providing the primary key to the Agent and the External Code associated to the Agent Market. | |
|
NOTES |
|
The MssApiService specific to each customer must 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. |