Create Time Profile Entity

Create Time Profile Entity. It describes access rules which can be attached to identifiers.

application/json

Request Body required

• name string required

  Possible values: <= 100 characters

  Name of the time profile

• time_options object required

  Time options of the time profile

  is_all_day boolean required

  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 required

  The model describes repeat option for time range in Time profile

  repeat_enable boolean required

  Determines if repeat function enabled

  repeat_format object

  The model describes repeat format in time profile

  repeat_type string required

  Possible values: [day, week, twoWeeks, month, year, custom]

  Period of repeating

  repeat_end object required

  Describes repeat period end. date key required if date format was chosen

  format string required

  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 required

  Possible values: [day, week, month, year]

  Repeat type options

  repeat_looper integer required

  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

  format string

  Possible values: [dayNumbers, parameterizedDay]

  Format of range used in repeating

  range object

  Monthly repeat type range option

  oneOf

  • MOD1
  • MOD2

  ---

  integer

  Possible values: >= 1 and <= 31

  Month day number

  week_order string

  Possible values: [first, second, third, fourth, fifth, last]

  Number of week day in a month, eg second monday or fourth sunday

  day_type string

  Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN, DAY, WEEK_DAY, DAY_OFF]

  Representation of the week day

  months integer[] required

  Possible values: >= 1, <= 12

  List of picked months

  format string required

  Possible values: [parameterizedDay]

  Format of range used in repeating

  months integer[] required

  Possible values: >= 1, <= 12

  List of picked months

  range object

  Describes day as point of time

  week_order string

  Possible values: [first, second, third, fourth, fifth, last]

  Number of week day in a month, eg second monday or fourth sunday

  day_type string

  Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN, DAY, WEEK_DAY, DAY_OFF]

  Representation of the week day

Responses

• 200
• 400
• 401

---

The id value returned in the response can be used as the time-profile-id parameter in:

• GET /access/time-profiles/{time-profile-id}

• to get info about time profile

• PATH /access/time-profiles/{time-profile-id}

• to update time profile

• DELETE /access/time-profiles/{time-profile-id}

• to remove time profile

• POST /access/identifiers/{identifier-id}/time-profiles/{time-profile-id}

• to attach time profile to identifier with id identifier-id

• DELETE /access/identifiers/{identifier-id}/time-profiles/{time-profile-id}

• to detach time profile from identifier with id identifier-id

application/json

• Schema
• Example (from schema)

---

Schema

• id integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

{
  "id": 3
}

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"
  }
}

Loading...