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": "d0c45a80-a53f-4f04-b2c4-8ce3947a06a0",
  "date_start": "2025-11-16T05:53:34.1229953+00:00",
  "date_end": "2025-11-16T05:53:34.1386171+00:00",
  "modified_dateutc": "2025-11-16T05:53:34.1386171+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "9aadcf9f-6532-401c-8911-44e486018ab5",
  "user_code": "sample string 8",
  "user": {
    "id": "caa3599c-4801-4d16-9821-61602156c8d2",
    "db_language_id": "213ee1ed-7179-4d3f-b9c5-2eb5fbc34c39",
    "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-11-16T05:53:34.2011175+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "e8e55561-6de1-4d90-a87c-1e07234d33a1",
    "sales_organization": {
      "id": "5b57ed62-68c6-4592-93a8-142b49a17452",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "93424e55-ccc3-4e41-879a-37e9423938a4",
      "db_currency_id": "09631f0f-ba3b-4596-a90b-982c2dda8eed",
      "db_language_id": "9d84b2f5-6962-44be-bba7-ff8d431739c6",
      "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-11-16T05:53:34.2011175+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "9b7f325c-54ed-41ee-9292-1a02feedfba4",
    "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": "2226d4a3-8215-4333-975a-458f1f099d0a",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-11-16T05:53:34.2011175+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "4b16926b-84f7-4a5a-92c4-5de90e8bf6e1"
  },
  "user_unavailability_type_id": "97b3bdbf-ce99-4f42-b0b4-d2a29ee05966",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "ff4696e9-23f1-47e8-b848-73e476b699dc",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "9f6c141d-2fad-4db9-99cb-dfca22402a7f",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "5b57ed62-68c6-4592-93a8-142b49a17452",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "93424e55-ccc3-4e41-879a-37e9423938a4",
      "db_currency_id": "09631f0f-ba3b-4596-a90b-982c2dda8eed",
      "db_language_id": "9d84b2f5-6962-44be-bba7-ff8d431739c6",
      "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-11-16T05:53:34.2011175+00:00"
    },
    "modified_dateutc": "2025-11-16T05:53:34.2011175+00:00"
  }
}