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": "6e9f8008-45b4-4901-8ff4-ac78b19bb108",
  "date_start": "2026-02-18T04:58:42.3566989+00:00",
  "date_end": "2026-02-18T04:58:42.3566989+00:00",
  "modified_dateutc": "2026-02-18T04:58:42.3566989+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "f5f6cc27-57d7-4792-b13b-6cb13619f76c",
  "user_code": "sample string 8",
  "user": {
    "id": "32e1932e-fd98-48d1-afab-123bbe72b181",
    "db_language_id": "09ab9cac-0196-42b2-bcf8-df75da3a857a",
    "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-02-18T04:58:42.3566989+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "538dc685-16e3-4632-ac92-7ab5b3cc780d",
    "sales_organization": {
      "id": "173020e0-666a-477d-95a7-4a65ccf12d7e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "fb5f450d-5b23-42ee-8a17-457fea3204c7",
      "db_currency_id": "f63489cb-509a-49db-83e8-899ef81bac4d",
      "db_language_id": "9dc540c2-ae97-4f96-817e-d9285157bea9",
      "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-02-18T04:58:42.3566989+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "21c9f576-d40a-430d-a902-ddaac6bac4bc",
    "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": "fa019d32-4e57-461a-a4f4-efbb696b040f",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-02-18T04:58:42.3566989+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "94da58b5-72fd-4cac-a876-8e54c58bf2a3"
  },
  "user_unavailability_type_id": "e42ed620-5e96-4eb8-8b69-a1c355e2dae8",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "17c9aa4e-fb64-432c-808d-e461f795bcdb",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "83439587-e9df-4b16-8054-6ae36c375027",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "173020e0-666a-477d-95a7-4a65ccf12d7e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "fb5f450d-5b23-42ee-8a17-457fea3204c7",
      "db_currency_id": "f63489cb-509a-49db-83e8-899ef81bac4d",
      "db_language_id": "9dc540c2-ae97-4f96-817e-d9285157bea9",
      "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-02-18T04:58:42.3566989+00:00"
    },
    "modified_dateutc": "2026-02-18T04:58:42.3566989+00:00"
  }
}