Get Company Entity

• Returns information about Company and attached Apartments.
• This feature is available only in AA-14FBIS panel

Path Parameters

• company-uid integer required

  Possible values: >= 1

  Unique Identifier for Company Item

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• name string

  Possible values: non-empty and <= 200 characters

  Company name. Should be unique

• info string

  Possible values: <= 1000 characters

  Additional Company info

• text_color string

  Possible values: [auto, black, white]

  Additional option to customize text color in Company screen. auto - system will try to calculate proper text color according to background image white - white text color will be used black - black text color will be used

• link_id string

  Link unique ID

• logo_path string

  This url may be used for downloading image

• background_path string

  This url may be used for downloading image

• apartments object

  Model used to providing array of UIDs of various enumerated entities are stored in the panel, such as apartments, identifiers, forward, and similar with count param

  uid_items integer[]

  Possible values: >= -1

  Array of UID for entities references

  link_ids uuid[]

  Array of LinkIDs for entities references

  count integer

  The number of values in the array

{
  "name": "BAS-IP",
  "info": "Company info",
  "text_color": "black",
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "logo_path": "/api/v1/files?imagePath=WallpaperImage.jpg",
  "background_path": "/api/v1/files?imagePath=WallpaperImage.jpg",
  "apartments": {
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b1",
      "91c615e3-1040-4815-8ecb-039a18b756b2",
      "91c615e3-1040-4815-8ecb-039a18b756b3",
      "91c615e3-1040-4815-8ecb-039a18b756b4"
    ],
    "count": 4
  }
}

{
  "name": "BAS-IP",
  "info": "Company info",
  "link_id": "123e4567-e89b-12d3-a456-326655440000",
  "text_color": "black",
  "logo_path": "/api/v1/files?imagePath=logo-e3c-c7f49894b4d8.jpg",
  "background_path": "/api/v1/files?imagePath=background-088-555ae8dbf1d5.jpg",
  "call_background_path": "/api/v1/files?imagePath=call-background-188-555ae8dbf1d5.jpg",
  "apartments": {
    "count": 2,
    "uid_items": [
      1,
      2
    ],
    "link_ids": [
      "123e4567-e89b-12d3-a456-326655440001",
      "123e4567-e89b-12d3-a456-326655440002"
    ]
  }
}

• Wrong company uid

application/json

• Schema
• Example (from schema)
• Wrong uid

---

Schema

• error string

  Error message

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong company uid"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...