Get Time Profiles list

Returns Time Profiles list

Query Parameters

limit integer
Possible values: [10, 20, 30, 50]
Number of items. Value by default is 10
page_number integer
Possible values: >= 1
Page number
sort_field string
Field name (JSON Key in item entity)
sort_type string
Possible values: [asc, desc]
Default value: asc
Sort type (asc/desc)
filter object
Filtering options for TimeProfile

Responses

application/json

Schema
Example (from schema)
Equal ` Work week`
Since Monday, October 29, 2018 1:21:11 P M (1540819271 timestamp)
Until Monday, October 29, 2018 1:21:13 P M (1540819273 timestamp)

Schema

list_items object[]
List of TimeProfiles
list_option object
This object provides filter, pagination and sort options for time profiles table
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: [10, 25, 50]
Limiting the display of the amount of data for one page
total_pages integer
Possible values: >= 1
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
filter object
Available filter sets for time profiles
oneOf
MOD1
MOD2
MOD3
filter_field string
Field available for filtering
filter_type string
Possible values: [equal]
Available filtering type
filter_format string
Data format, only string here
filter_value int64
Time profile date_from param
sort object
Available sorting options for the time profile table
field string
Sorting field name
asc boolean
Sort direction
available_fields undefined[]
Possible values: [name, date_from, date_to]
Available for sorting fields names

{
  "list_items": [
    {
      "time_profile_uid": 1,
      "name": "Worker 1",
      "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": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    },
    {
      "time_profile_uid": 2,
      "name": "Worker 2",
      "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": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    },
    {
      "time_profile_uid": 3,
      "name": "Worker 3",
      "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": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "date_from",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": 1540819272
    },
    "sort": {
      "field": "name",
      "asc": true,
      "available_fields": [
        "name"
      ]
    }
  }
}

{
  "list_items": [
    {
      "time_profile_uid": 1,
      "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": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Work week",
      "available_filtering": true,
      "available_fields": [
        "name",
        "date_from",
        "date_to"
      ],
      "is_filtered": true
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "date_to",
        "date_from",
        "name"
      ]
    }
  }
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 1,
      "current_page": 1
    },
    "filter": {
      "is_filtered": true,
      "available_filtering": true,
      "filter_format": "number",
      "filter_type": "equal",
      "available_fields": [
        "date_to",
        "date_from",
        "name"
      ],
      "filter_field": "date_from",
      "filter_value": "1540819271"
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "date_to",
        "date_from",
        "name"
      ]
    }
  },
  "list_items": [
    {
      "repeat_options": {
        "repeat_enable": true,
        "repeat_format": {
          "repeat_end": {
            "date": 1540819272,
            "format": "date"
          },
          "repeat_type": "day"
        }
      },
      "identifiers": {
        "count": 1,
        "uid_items": [
          1
        ]
      },
      "time_profile_uid": 1,
      "time_options": {
        "is_all_day": true,
        "date_to": 1540819272,
        "date_from": 1540819272
      },
      "name": "Work week"
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 1,
      "current_page": 1
    },
    "filter": {
      "is_filtered": true,
      "available_filtering": true,
      "filter_format": "number",
      "filter_type": "equal",
      "available_fields": [
        "date_to",
        "date_from",
        "name"
      ],
      "filter_field": "name",
      "filter_value": "1540819273"
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "date_to",
        "date_from",
        "name"
      ]
    }
  },
  "list_items": [
    {
      "repeat_options": {
        "repeat_enable": true,
        "repeat_format": {
          "repeat_end": {
            "date": 1540819272,
            "format": "date"
          },
          "repeat_type": "day"
        }
      },
      "identifiers": {
        "count": 1,
        "uid_items": [
          1
        ]
      },
      "time_profile_uid": 1,
      "time_options": {
        "is_all_day": true,
        "date_to": 1540819272,
        "date_from": 1540819272
      },
      "name": "Work week"
    }
  ]
}

Base errors for all entities

Wrong pagination limit
Wrong page number
Wrong filter type
Wrong filter field
Wrong filter format
Wrong filter value
Wrong sort type
Errors appeared only in log entities:
Wrong time format
Wrong time range: 'to' must be greater then 'from'
Errors appeared in other entities:
Wrong sort field

application/json

Schema

error string
Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "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 message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Get Time Profiles list​

Get Time Profiles list