Use this request to add an Agent Market record. This market is stored within the Market table and accessible through Agent Market Setup.
Request Format
https://://{server}/api/agents/markets
HTTPS:// Verb/Method:
POST
Request Parameter
An Agent Market record in JSON format (example below) along with the following server specification.
|
Parameter |
Description |
|
{server} |
Provide the name of the server running the MoversSuite API Service. |
REQUEST EXAMPLE:
https://://server/api/agents/markets
SAMPLE SUCCESSFUL RETURN:
{
"Description": "A New Market",
"ExternalCode": "ANM",
}
The following table describes the data required by this method.
|
Property |
Description |
|
Description |
Corresponds to the Description field for an Agent Market Setup record (up to 100 characters). |
|
ExternalCode |
Corresponds to the External Code field for an Agent Market Setup record (up to 32 characters). |
Request Return
Upon a successful call, the request returns primary key of the newly added Agent Market Setup record.
Upon an error, the request returns zero (0) and writes an exception message to the MssApiService log.