Get the list of time profiles

Return the list of time profiles

Path Parameters

user-id integer required
Possible values: >= 1
Unique Identifier for User Item

Query Parameters

limit integer required
Possible values: <= 1000
Number of items. Value by default is 10
page_number integer required
Possible values: >= 1
Page number

Responses

application/json

Schema
Example (from schema)

Schema

items object[]
List items
id integer
Possible values: >= -1
UID for entities references. If value is -1, then it means that is no entity reference for this structure
link_id object
Unique entity set by the server to bind some parameters with each other
name string
Possible values: <= 100 characters
Name of the time profile
time_options object
Time options of the time profile
is_all_day boolean
Determines if all day used for checking access, from 00.00 to 23.59
date_from object
Unix Timestamp Date
date_to object
Unix Timestamp Date
repeat_options object
The model describes repeat option for time range in Time profile
repeat_enable boolean
Determines if repeat function enabled
repeat_format object
The model describes repeat format in time profile
repeat_type string
Possible values: [day, week, twoWeeks, month, year, custom]
Period of repeating
repeat_end object
Describes repeat period end. date key required if date format was chosen
format string
Possible values: [never, date]
Repeat period ending options
date int64
Unix Timestamp Date
repeat_custom object
Only for custom repeat type
repeat_point_type string
Possible values: [day, week, month, year]
Repeat type options
repeat_looper integer
Possible values: >= 1 and <= 1000
Number of repeats
repeat_options object
Repeat settings
oneOf
MOD1
MOD2
MOD3
MOD4
string
Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN]
Week day representation
options object
Available pagination options
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: <= 1000
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

{
  "items": [
    {
      "id": 3,
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "name": "Work week",
      "time_options": {
        "is_all_day": true,
        "date_from": 1540819272,
        "date_to": 1540819272
      },
      "repeat_options": {
        "repeat_enable": true,
        "repeat_format": {
          "repeat_type": "day",
          "repeat_end": {
            "format": "date",
            "date": 1540819272
          },
          "repeat_custom": {
            "repeat_point_type": "week",
            "repeat_looper": 5,
            "repeat_options": [
              "MON",
              "TUE",
              "WED",
              "THU",
              "FRI"
            ]
          }
        }
      }
    }
  ],
  "options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  }
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
Error code
message string
Error message
data object
Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.
param string
Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Example

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
Error code
message string
Error message
data object
Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.
param string
Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Get the list of time profiles​

Get the list of time profiles