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": "d7b5737d-3d0d-41c2-84de-16cd1394123a",
  "date_start": "2025-12-01T19:21:48.4150208+00:00",
  "date_end": "2025-12-01T19:21:48.4150208+00:00",
  "modified_dateutc": "2025-12-01T19:21:48.4150208+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "d1169a44-58db-41ef-ae7a-1074502687fd",
  "user_code": "sample string 8",
  "user": {
    "id": "08c18345-3e5a-4886-ac6c-e40a073aba56",
    "db_language_id": "665a7f9d-de4d-4837-a031-cb2cdad0778a",
    "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-01T19:21:48.4150208+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "b147c9a4-8ce4-4a49-a28a-2af21770bc62",
    "sales_organization": {
      "id": "ada4e8cb-8e90-48b0-b68c-950e6d3ae050",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "3bffb7e9-c2f6-4227-9f31-dac41bf0ffc8",
      "db_currency_id": "ea2a21fe-d785-4984-8695-7a8136c5bf3d",
      "db_language_id": "95d936b0-29dc-4888-8eff-9acf3be6baa9",
      "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-01T19:21:48.4150208+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "32eec483-ea7f-4d00-aeef-a17f67c70035",
    "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": "249dc63b-6d55-4c6d-9ef2-cce3d89778e7",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-12-01T19:21:48.4150208+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "245e94f4-9935-4d10-a6a8-7bf2e78c722e"
  },
  "user_unavailability_type_id": "56ffaea4-fe69-41e4-bf1a-58bfd74c5177",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "c33a0d00-26a6-42d8-ab8b-424cc5344dad",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "d5b49ed5-5f76-44a0-a7a6-3c716c1f618f",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "ada4e8cb-8e90-48b0-b68c-950e6d3ae050",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "3bffb7e9-c2f6-4227-9f31-dac41bf0ffc8",
      "db_currency_id": "ea2a21fe-d785-4984-8695-7a8136c5bf3d",
      "db_language_id": "95d936b0-29dc-4888-8eff-9acf3be6baa9",
      "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-01T19:21:48.4150208+00:00"
    },
    "modified_dateutc": "2025-12-01T19:21:48.4150208+00:00"
  }
}