GET api/admin/v{version}/companies

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

None.

Response Information

Resource Description

CompanyList
NameDescriptionTypeAdditional information
companies

Collection of Company

None.

Response Formats

application/json, text/json

Sample:
{
  "companies": [
    {
      "id": 1,
      "name": "sample string 2",
      "api_Key": "sample string 3",
      "enabled": 4,
      "docscanner": 5
    },
    {
      "id": 1,
      "name": "sample string 2",
      "api_Key": "sample string 3",
      "enabled": 4,
      "docscanner": 5
    }
  ]
}

text/html

Sample:
{"companies":[{"id":1,"name":"sample string 2","api_Key":"sample string 3","enabled":4,"docscanner":5},{"id":1,"name":"sample string 2","api_Key":"sample string 3","enabled":4,"docscanner":5}]}

application/xml, text/xml

Sample:
<CompanyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.Data">
  <companies>
    <Company>
      <api_Key>sample string 3</api_Key>
      <docscanner>5</docscanner>
      <enabled>4</enabled>
      <id>1</id>
      <name>sample string 2</name>
    </Company>
    <Company>
      <api_Key>sample string 3</api_Key>
      <docscanner>5</docscanner>
      <enabled>4</enabled>
      <id>1</id>
      <name>sample string 2</name>
    </Company>
  </companies>
</CompanyList>