Retrieves the unavailability with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

user_unavailability
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier
date_start

Date+Time of the beginning

date

Required

date_end

Date+Time of the end

date

Required

modified_dateutc

Date+Time of the modified

date

Required

description

Description of the unavailability

string

Max length: 255

is_approved

Indicate if this object has been approved using a User Week Approval

boolean
user_id

User owner of this unavailability

globally unique identifier

Optionally required : user_id, user_code or user must be provided

user_code

Embedded entity "user" using ERP PK when adding/updating user_unavailability

string

Optionally required : user_id, user_code or user must be provided

user

Embedded entity "user" using node when adding/updating user_unavailability

user

Optionally required : user_id, user_code or user must be provided

user_unavailability_type_id

Type of the unavailability, cf model user_unavailability_type

globally unique identifier

Required

Optionally required : user_unavailability_type_id, user_unavailability_type_code or user_unavailability_type must be provided

user_unavailability_type_code

Embedded entity "user_unavailability_type" using ERP PK when adding/updating user_unavailability

string

Optionally required : user_unavailability_type_id, user_unavailability_type_code or user_unavailability_type must be provided

user_unavailability_type

Embedded entity "user_unavailability_type" using node when adding/updating user_unavailability

user_unavailability_type

Optionally required : user_unavailability_type_id, user_unavailability_type_code or user_unavailability_type must be provided

Response Formats

application/json, text/json

Sample:
{
  "id": "5b969614-5cdc-4426-b6fb-7e095ea96a92",
  "date_start": "2025-10-02T08:06:36.5721659+00:00",
  "date_end": "2025-10-02T08:06:36.5721659+00:00",
  "modified_dateutc": "2025-10-02T08:06:36.5721659+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "cc516bd8-90da-491f-a998-99e73320bd15",
  "user_code": "sample string 8",
  "user": {
    "id": "289e3d6b-9e90-4286-91a1-82c496dd46dc",
    "db_language_id": "5acf8218-1f45-48b0-824c-6b3e811796de",
    "username": "sample string 3",
    "firstname": "sample string 4",
    "lastname": "sample string 5",
    "code": "sample string 6",
    "archived": true,
    "disabled": true,
    "emergency_contact": "sample string 9",
    "bankaccount": "sample string 10",
    "social_security": "sample string 11",
    "place_of_birth": "sample string 12",
    "nationality": "sample string 13",
    "functions": "sample string 14",
    "birthdate": "2025-10-02T08:06:36.5721659+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "2def4c5c-4c9b-4897-ac79-99042cc19a96",
    "sales_organization": {
      "id": "5f9beb70-74ea-4e19-8d9f-640e5ab32271",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d0cfd5d3-a103-4fef-a606-5b191bb9cd46",
      "db_currency_id": "33dee18e-3981-4b75-b4e1-0773a73a3c1f",
      "db_language_id": "bafc378d-4d67-4736-9c59-b359681df7f0",
      "accountancy_code": "sample string 8",
      "archived": true,
      "default_unit_of_measure_system_type": "sample string 10",
      "street": "sample string 11",
      "street2": "sample string 12",
      "street_number": "sample string 13",
      "zip": "sample string 14",
      "city": "sample string 15",
      "email": "sample string 16",
      "phone": "sample string 17",
      "fax": "sample string 18",
      "url": "sample string 19",
      "vat_reg_code": "sample string 20",
      "modified_dateutc": "2025-10-02T08:06:36.5721659+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "70f24de2-8d65-46f7-afd3-fe58c5b0ed51",
    "email": "sample string 22",
    "phone": "sample string 23",
    "fax": "sample string 24",
    "mobile": "sample string 25",
    "private_email": "sample string 26",
    "private_phone": "sample string 27",
    "private_fax": "sample string 28",
    "private_mobile": "sample string 29",
    "private_street": "sample string 30",
    "private_street_number": "sample string 31",
    "private_city": "sample string 32",
    "private_zip": "sample string 33",
    "private_db_country_id": "7ea3fbf8-bc1a-4248-a0fa-5fd48106687f",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-10-02T08:06:36.5721659+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "c7bdb407-2f32-4000-a479-70b951fda7ca"
  },
  "user_unavailability_type_id": "b530ae04-3eae-4dee-9353-2a63487c231d",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "250d5fb9-0b77-475d-9ed6-52a2bd476af5",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "0e6c0660-1f06-4ce1-8603-288b5a5db148",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "5f9beb70-74ea-4e19-8d9f-640e5ab32271",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d0cfd5d3-a103-4fef-a606-5b191bb9cd46",
      "db_currency_id": "33dee18e-3981-4b75-b4e1-0773a73a3c1f",
      "db_language_id": "bafc378d-4d67-4736-9c59-b359681df7f0",
      "accountancy_code": "sample string 8",
      "archived": true,
      "default_unit_of_measure_system_type": "sample string 10",
      "street": "sample string 11",
      "street2": "sample string 12",
      "street_number": "sample string 13",
      "zip": "sample string 14",
      "city": "sample string 15",
      "email": "sample string 16",
      "phone": "sample string 17",
      "fax": "sample string 18",
      "url": "sample string 19",
      "vat_reg_code": "sample string 20",
      "modified_dateutc": "2025-10-02T08:06:36.5721659+00:00"
    },
    "modified_dateutc": "2025-10-02T08:06:36.5721659+00:00"
  }
}