Get Time Profile Entity
Returns Time Profile Entity
Path Parameters
- timeProfileUid integer required
Possible values:
>= 1
Unique Id for time profile
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- One day
- Daily
- Daily until date
- Weekly
- Every two weeks
- Monthly
- Yearly
- First day of the month
- Work week
Schema
- name string
time profile name
time_options object
time profile time options
is_all_day booleanis enabled for whole day
date_from int64Unix Timestamp Date
date_to int64Unix Timestamp Date
repeat_options object
The model describes repeat option for
time
range in Timeprofilerepeat_enable booleandescribes feature status, true - on / false - off
repeat_format object
The model describes repeat format in Timeprofile
repeat_type stringPossible values: [
day
,week
,twoWeeks
,month
,year
,custom
]how often time profile will repeat
repeat_end object
sets when time profile repeat event ends
format stringPossible values: [
never
,date
]date
key required ifdate
format was chosendate int64Unix Timestamp Date
repeat_custom object
Only for
custom
repeat typerepeat_point_type stringPossible values: [
day
,week
,month
,year
]custom repeat type
repeat_looper integerPossible values:
>= 1
and<= 1000
repeat loop
repeat_options object
different options for each repeat type
oneOf- MOD1
- MOD2
- MOD3
stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
]days of the week
format stringPossible values: [
dayNumbers
,parameterizedDay
]should specify which day type is used (parametrized or not)
range object
range of days
oneOf- MOD1
- MOD2
integerPossible values:
>= 1
and<= 31
list with day numbers
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]week order
day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]type of the day in the week
months integer[]Possible values:
>= 1
,<= 12
months of the year
range object
object of the day with additional parameters
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]week order
day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]type of the day in the week
identifiers 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
paramuid_items integer[]Possible values:
>= -1
Array of UID for entities referenses.
count integerThe number of values in the array
{
"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"
]
}
}
},
"identifiers": {
"uid_items": [
11,
13,
23,
42
],
"count": 4
}
}
{
"time_profile_uid": 327,
"name": "One day",
"link_id": null,
"time_options": {
"is_all_day": true,
"date_from": 1601884800,
"date_to": 1601920800
},
"repeat_options": {
"repeat_enable": false
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 329,
"name": "Daily infinitely",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "day",
"repeat_end": {
"format": "never",
"date": null
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 330,
"name": "Work Week",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "day",
"repeat_end": {
"format": "date",
"date": 1606780800
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 331,
"name": "Weekly infinitely",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "week",
"repeat_end": {
"format": "never",
"date": null
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 332,
"name": "Every two weeks infinitely",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "twoWeeks",
"repeat_end": {
"format": "never",
"date": null
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 334,
"name": "Monthly infinitely",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "month",
"repeat_end": {
"format": "never",
"date": null
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 335,
"name": "Yearly infinitely",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "year",
"repeat_end": {
"format": "never",
"date": null
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 336,
"name": "First day of the month",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601539200,
"date_to": 1601575200
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "custom",
"repeat_end": {
"format": "never",
"date": null
},
"repeat_custom": {
"repeat_point_type": "month",
"repeat_looper": 1,
"repeat_options": {
"format": "dayNumbers",
"range": [
1
]
}
}
}
},
"identifiers": {
"count": 1,
"uid_items": [
141
]
}
}
{
"time_profile_uid": 337,
"name": "Work Week",
"link_id": null,
"time_options": {
"is_all_day": false,
"date_from": 1601884800,
"date_to": 1601920800
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "custom",
"repeat_end": {
"format": "date",
"date": 1609372800
},
"repeat_custom": {
"repeat_point_type": "week",
"repeat_looper": 1,
"repeat_options": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
]
}
}
},
"identifiers": {
"count": 0,
"uid_items": [
141
]
}
}
Wrong Time Profile Uid
- application/json
- Schema
- Example (from schema)
- Wrong time profile uid
Schema
- error string
error type/info
{
"error": "Wrong JSON body"
}
{
"error": "Wrong Time Profile Uid"
}
Log In
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
error message
{
"error": "Log In"
}
{
"error": "Log In"
}