Get Time Profile Entity

Returns Time Profile Entity

Path Parameters

• timeProfileUid integer required

  Possible values: >= 1

  Unique Id for time profile

Responses

• 200
• 400
• 401
• 403

---

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_options object

  is_all_day boolean

  date_from int64

  Unix Timestamp Date

  date_to int64

  Unix Timestamp Date

• repeat_options object

  The model describes repeat option for time range in Timeprofile

  repeat_enable boolean

  repeat_format object

  The model describes repeat format in Timeprofile

  repeat_type string

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

  repeat_end object

  date key required if date format was chosen

  format string

  Possible values: [never, date]

  date int64

  Unix Timestamp Date

  repeat_custom object

  Only for custom repeat type

  repeat_point_type string

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

  repeat_looper integer

  Possible values: >= 1 and <= 1000

  repeat_options object

  oneOf

  • MOD1
  • MOD2
  • MOD3

  ---

  string

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

  format string

  Possible values: [dayNumbers, parameterizedDay]

  range object

  oneOf

  • MOD1
  • MOD2

  ---

  integer

  Possible values: >= 1 and <= 31

  week_order string

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

  day_type string

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

  months integer[]

  Possible values: >= 1, <= 12

  range object

  week_order string

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

  day_type string

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

• identifiers object

  Model used to providing array of UIDs of various enumerated entities stored in the panel, such as apartments, identifiers, forward, and similar

  uid_items integer[]

  Possible values: >= -1

  Array of UID for entities referenses.

  count integer

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

{
  "name": "One day",
  "repeat_options": {
    "repeat_enable": false
  },
  "time_options": {
    "is_all_day": true,
    "date_to": 1601920800,
    "date_from": 1601884800
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Daily infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "day"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Work Week",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "date": 1606780800,
        "format": "date"
      },
      "repeat_type": "day"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Weekly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "week"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Every two weeks infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "twoWeeks"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Monthly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "month"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Yearly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "year"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "First day of the month",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_custom": {
        "repeat_looper": 1,
        "repeat_options": {
          "range": [
            1
          ],
          "format": "dayNumbers"
        },
        "repeat_point_type": "month"
      },
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "custom"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

{
  "name": "Work Week",
  "time_options": {
    "is_all_day": false,
    "date_to": 1601920800,
    "date_from": 1601884800
  },
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_custom": {
        "repeat_looper": 1,
        "repeat_options": [
          "WED",
          "FRI",
          "MON",
          "TUE",
          "THU"
        ],
        "repeat_point_type": "week"
      },
      "repeat_end": {
        "date": 1609372800,
        "format": "date"
      },
      "repeat_type": "custom"
    }
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  }
}

Wrong Time Profile Uid

application/json

• Schema
• Example (from schema)
• Wrong time profile uid

---

Schema

• error string

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong Time Profile Uid"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

{
  "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": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...