Get a list of Companies

• Returns a list of Companies with options could be used to sort and filter them.
• This feature is available only in AA-14FBIS panel

Query Parameters

• limit integer

  Possible values: [10, 20, 30, 50]

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

• sort_field string

  Field name (JSON Key in item entity)

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options for Apartment

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_items object[]

  List of Companies

• list_option object

  Available options for sorting, filtering and pagination of lists

  pagination object

  Available pagination options for tables

  total_items integer

  The total number of items found and reflected across all pages

  items_limit integer

  Possible values: [10, 20, 30, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  filter object

  Available filter sets for apartments

  anyOf

  • MOD1
  • MOD2

  ---

  filter_field string

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filtering type, only equal here

  filter_format string

  Data format, only string here

  filter_value string

  Filter value

  filter_field string

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filtering type, only equal here

  filter_format string

  Data format, only string here

  filter_value string

  Link id

  sort object

  Available sorting options for the selected table

  field string

  Sorting field name

  asc boolean

  Sort direction

  available_fields undefined[]

  Possible values: [name, link_id]

  Available for sorting fields names

{
  "list_items": [
    {
      "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
      },
      "item_uid": 3
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "BAS-IP"
    },
    "sort": {
      "field": "apartment_name",
      "asc": true,
      "available_fields": [
        "name"
      ]
    }
  }
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "BAS-IP",
      "available_filtering": true,
      "available_fields": [
        "name",
        "link_id"
      ],
      "is_filtered": true
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "name",
        "link_id"
      ]
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "link_id": "123e4567-e89b-12d3-a456-326655440000",
      "name": "BAS-IP",
      "info": "Company info",
      "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"
        ]
      }
    }
  ]
}

Base errors for all entities

• Wrong pagination limit
• Wrong page number
• Wrong filter type
• Wrong filter field
• Wrong filter format
• Wrong filter value
• Wrong sort type
  Errors appeared only in log entities:
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
  Errors appeared in other entities:
• Wrong sort field

application/json

• Schema
• Example (from schema)
• Pagination Limit
• Pagination Page Number
• Sort type
• Sort field
• Filter type
• Filter field
• Filter value
• Filter format
• Time format
• Time range

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

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...