GET api/Company

Get a list of companies connected to the API User

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of Company Identifiers

GetCompanyListMessageResponse
NameDescriptionTypeAdditional information
Header

Header item

MessageHeader

None.

CompanyIdentifiers

List of Company identifiers

Collection of string

None.

Footer

Footer item

MessageFooter

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "CompanyIdentifiers": [
    "string 1",
    "string 2"
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:
<GetCompanyListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <CompanyIdentifiers>
    <string>string 1</string>
    <string>string 2</string>
  </CompanyIdentifiers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetCompanyListMessageResponse>