GET api/companies/{C4Uid}/offices

Get Company information based on the market id

Request Information

Authentication

This method requires device authentication

URI Parameters

NameDescriptionTypeAdditional information
C4Uid

(Required) See GET api/markets to get C4Uid

string

Required

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfCompanyInfo
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of CompanyInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Elements": [
    {
      "CompanyId": 1,
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zip": "sample string 7",
      "Phone": "sample string 8",
      "Fax": "sample string 9",
      "Country": "sample string 10",
      "Directions": "sample string 11",
      "HoursOfOperation": "sample string 12",
      "ShowCallCenterPage": true,
      "ShowLoginPage": true
    },
    {
      "CompanyId": 1,
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zip": "sample string 7",
      "Phone": "sample string 8",
      "Fax": "sample string 9",
      "Country": "sample string 10",
      "Directions": "sample string 11",
      "HoursOfOperation": "sample string 12",
      "ShowCallCenterPage": true,
      "ShowLoginPage": true
    }
  ]
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)