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": "63e7557a-a2fb-4f8a-ba24-c76662da4d49",
  "date_start": "2026-01-07T06:02:59.2854487+00:00",
  "date_end": "2026-01-07T06:02:59.2854487+00:00",
  "modified_dateutc": "2026-01-07T06:02:59.2854487+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "30ee175a-9408-4809-bcc7-8c1c934dded6",
  "user_code": "sample string 8",
  "user": {
    "id": "38e9fbec-a107-4526-81e7-43894709cae1",
    "db_language_id": "055c6404-f7b0-4c6d-b7b4-538f03474665",
    "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-07T06:02:59.2854487+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "2f71b530-2513-40f8-bab2-9188afe99dee",
    "sales_organization": {
      "id": "0268fffd-9a70-4086-912a-d3ee93fae153",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5fe02d91-7434-4cbe-93e9-bb066bf9b459",
      "db_currency_id": "33a73495-a8cf-4512-bf6a-a4d8ee4ace1d",
      "db_language_id": "728f02b0-6808-43e5-b7f2-ac924f3bc3dd",
      "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-07T06:02:59.2854487+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "dbccd116-2115-4a3b-9f7c-d7a07e6bb6b4",
    "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": "cb868812-45ab-4da0-a703-db23029b8bac",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-01-07T06:02:59.3010768+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "48f296b4-3b17-469e-9c86-50fe2ee56a04"
  },
  "user_unavailability_type_id": "4abd834b-127d-4e2f-9c1b-df10fc2ab62e",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "5342b476-9c04-4f90-915f-00fbcd5a5b26",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "d102d303-3f88-4bc8-8c61-4a280d4ce50b",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "0268fffd-9a70-4086-912a-d3ee93fae153",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5fe02d91-7434-4cbe-93e9-bb066bf9b459",
      "db_currency_id": "33a73495-a8cf-4512-bf6a-a4d8ee4ace1d",
      "db_language_id": "728f02b0-6808-43e5-b7f2-ac924f3bc3dd",
      "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-07T06:02:59.2854487+00:00"
    },
    "modified_dateutc": "2026-01-07T06:02:59.3010768+00:00"
  }
}