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": "1bb463ec-0330-4db3-bcec-52cac7521eb3",
  "date_start": "2025-12-16T13:41:53.0011317+00:00",
  "date_end": "2025-12-16T13:41:53.0011317+00:00",
  "modified_dateutc": "2025-12-16T13:41:53.0011317+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "62d6dc3a-f52c-43bd-b3c0-aac5aafb2208",
  "user_code": "sample string 8",
  "user": {
    "id": "05cf20d5-803c-4d80-97ee-a0c535f52e36",
    "db_language_id": "b9482442-b080-45a3-b3b8-03ff581bbec6",
    "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-12-16T13:41:53.0011317+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "4fd7f484-d818-424a-aa6c-779fd1081bcf",
    "sales_organization": {
      "id": "ff9e4a42-be6d-4aa4-bfca-54efe56b400d",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9addb88b-f7ad-40ff-b11d-6d9cb731c51e",
      "db_currency_id": "113ff786-97ec-4c1d-a7a5-d6340ee91d57",
      "db_language_id": "114bfd17-e22b-4364-bf44-02c35104abda",
      "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-12-16T13:41:53.0167559+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "ee4bfda1-8c06-4321-85a5-258ab0cf45bc",
    "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": "93a869a5-0cdd-41f8-8084-24ea7bd457a7",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-12-16T13:41:53.0167559+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "f2a4ac54-3874-45cd-b68e-ee8f93f142b6"
  },
  "user_unavailability_type_id": "353668cc-98e9-48c1-8aca-45e7d0fb2382",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "21283fa6-691b-4cb7-9a58-e71b40455955",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "649a7c9c-6e5c-419a-9b7a-6650bad50a60",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "ff9e4a42-be6d-4aa4-bfca-54efe56b400d",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9addb88b-f7ad-40ff-b11d-6d9cb731c51e",
      "db_currency_id": "113ff786-97ec-4c1d-a7a5-d6340ee91d57",
      "db_language_id": "114bfd17-e22b-4364-bf44-02c35104abda",
      "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-12-16T13:41:53.0167559+00:00"
    },
    "modified_dateutc": "2025-12-16T13:41:53.0167559+00:00"
  }
}