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

  time profile name

• time_options object required

  time profile time options

  is_all_day boolean required

  is enabled for whole day

  date_from int64 required

  Unix Timestamp Date

  date_to int64 required

  Unix Timestamp Date

• repeat_options object required

  The model describes repeat option for time range in Timeprofile

  repeat_enable boolean required

  describes feature status, true - on / false - off

  repeat_format object

  The model describes repeat format in Timeprofile

  repeat_type string required

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

  how often time profile will repeat

  repeat_end object required

  sets when time profile repeat event ends

  format string required

  Possible values: [never, date]

  date key required if date format was chosen

  date int64 required

  Unix Timestamp Date

  repeat_custom object

  Only for custom repeat type

  repeat_point_type string required

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

  custom repeat type

  repeat_looper integer required

  Possible values: >= 1 and <= 1000

  repeat loop

  repeat_options object

  different options for each repeat type

  oneOf

  • MOD1
  • MOD2
  • MOD3

  ---

  string

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

  days of the week

  format string

  Possible values: [dayNumbers, parameterizedDay]

  should specify which day type is used (parametrized or not)

  range object

  range of days

  oneOf

  • MOD1
  • MOD2

  ---

  integer

  Possible values: >= 1 and <= 31

  list with day numbers

  week_order string

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

  week order

  day_type string

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

  type of the day in the week

  months integer[] required

  Possible values: >= 1, <= 12

  months of the year

  range object

  object of the day with additional parameters

  week_order string

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

  week order

  day_type string

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

  type of the day in the week

Responses

• 200
• 400
• 401

---

The uid value returned in the response can be used as the timeProfileUid parameter in:

• GET /access/timeprofile/item/{timeProfileUid} - to get info about time profile
• PATH /access/timeprofile/item/{timeProfileUid} - to update time profile
• DELETE /access/timeprofile/item/{timeProfileUid} - to remove time profile
• POST /access/identifiers/item/{identifierUid}/timeProfile/{timeProfileUid} - to attach time profile to identifier with id identifierUid
• DELETE /access/identifiers/item/{identifierUid}/timeProfile/{timeProfileUid} - to detach time profile from identifier with id identifierUid

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  Possible values: >= -1

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

{
  "uid": 3
}

{
  "uid": 3
}

Wrong repeat options

application/json

• Schema
• Example (from schema)
• Wrong repeat_type
• Wrong format
• Wrong repeat_point_type
• Wrong repeat_options
• Wrong repeat_looper range
• Wrong Week Options
• Wrong year range
• Wrong Year Options
• Wrong Day Of Month
• Wrong months range
• Wrong day Numbers

---

Schema

• error string

  Possible values: [Wrong repeat_type, Wrong format enum name, Wrong repeat_point_type enum name, Wrong repeat_options enum name, Wrong repeat_looper range, Set in WeekOptions can't be empty, Wrong year range, Set in YearOptions can't be empty, Wrong DayOfMonth range, Wrong months range, Set in dayNumbers can't be empty, Wrong Time Profile Uid]

  error type/info

{
  "error": true
}

{
  "error": "Wrong repeat_type"
}

{
  "error": "Wrong format enum name"
}

{
  "error": "Wrong repeat_point_type enum name"
}

{
  "error": "Wrong repeat_options enum name"
}

{
  "error": "Wrong repeat_looper range"
}

{
  "error": "Set in WeekOptions can't be empty"
}

{
  "error": "Wrong year range"
}

{
  "error": "Set in YearOptions can't be empty"
}

{
  "error": "Wrong DayOfMonth range"
}

{
  "error": "Wrong months range"
}

{
  "error": "Set in dayNumbers can't be empty"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...