GET v1/imos/agents/{companyCode}?apiToken={apiToken}

Returns agent address book information for agents defined in IMOS for specific company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
apiToken		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample:

[
  {
    "name": "sample string 1",
    "shortName": "sample string 2",
    "addressLine1": "sample string 3",
    "addressLine2": "sample string 4",
    "addressLine3": "sample string 5",
    "country": "sample string 6",
    "email": "sample string 7",
    "companyNo": 8
  },
  {
    "name": "sample string 1",
    "shortName": "sample string 2",
    "addressLine1": "sample string 3",
    "addressLine2": "sample string 4",
    "addressLine3": "sample string 5",
    "country": "sample string 6",
    "email": "sample string 7",
    "companyNo": 8
  }
]

application/xml, text/xml

Sample:

<ImosAgents xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ImosAgentResponse>
    <Name>sample string 1</Name>
    <ShortName>sample string 2</ShortName>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <AddressLine3>sample string 5</AddressLine3>
    <Country>sample string 6</Country>
    <Email>sample string 7</Email>
    <CompanyNo>8</CompanyNo>
  </ImosAgentResponse>
  <ImosAgentResponse>
    <Name>sample string 1</Name>
    <ShortName>sample string 2</ShortName>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <AddressLine3>sample string 5</AddressLine3>
    <Country>sample string 6</Country>
    <Email>sample string 7</Email>
    <CompanyNo>8</CompanyNo>
  </ImosAgentResponse>
</ImosAgents>