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": "7ecd5481-8b2c-4479-8edb-7cf6ab29a202",
  "date_start": "2026-01-18T20:52:49.9240413+00:00",
  "date_end": "2026-01-18T20:52:49.9240413+00:00",
  "modified_dateutc": "2026-01-18T20:52:49.9240413+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "5e076c80-fbc7-46d3-969d-7c828961613e",
  "user_code": "sample string 8",
  "user": {
    "id": "b7305366-101c-46fa-8de6-9c532a1d173d",
    "db_language_id": "27ddc54e-3e12-4052-a8ea-24b26de3d861",
    "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": "2026-01-18T20:52:49.9240413+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "deff9b80-b75c-4380-ba52-616d8a48fea5",
    "sales_organization": {
      "id": "fe0cd992-7d31-476d-87b9-8a0bd93867f1",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "01c15b52-d799-4071-b004-bb46c8c5f5db",
      "db_currency_id": "0b092d97-6822-4dee-adbb-2be87e226438",
      "db_language_id": "0925cd46-ef56-41f9-9cbc-938b57dd7bb0",
      "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": "2026-01-18T20:52:49.9240413+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "7511d780-9e23-4184-a99f-f5ba750bd034",
    "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": "ea5f478d-d44f-4d49-b023-e5b920d6603e",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-01-18T20:52:49.9240413+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "4876f68a-f41f-4364-a47d-3be1048f84d4"
  },
  "user_unavailability_type_id": "21c4b4b0-4d2b-4cec-be1c-1efdba32cd3b",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "6d4dc9bf-0502-4a61-bfd9-a679c6ff0dc8",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "5e158dac-6763-4277-b219-ce285d5a71b3",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "fe0cd992-7d31-476d-87b9-8a0bd93867f1",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "01c15b52-d799-4071-b004-bb46c8c5f5db",
      "db_currency_id": "0b092d97-6822-4dee-adbb-2be87e226438",
      "db_language_id": "0925cd46-ef56-41f9-9cbc-938b57dd7bb0",
      "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": "2026-01-18T20:52:49.9240413+00:00"
    },
    "modified_dateutc": "2026-01-18T20:52:49.9240413+00:00"
  }
}