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": "d4d9ea47-4d98-4d4d-8c03-128c4029523f",
  "date_start": "2026-06-11T10:15:29.3007699+00:00",
  "date_end": "2026-06-11T10:15:29.3007699+00:00",
  "modified_dateutc": "2026-06-11T10:15:29.3007699+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "d61d04d5-bd4f-445c-b7c2-770baccc96d3",
  "user_code": "sample string 8",
  "user": {
    "id": "8e563399-0194-4b37-a691-8c853656c52c",
    "db_language_id": "c1eac503-7201-4fc3-bb3d-7180fe737879",
    "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-06-11T10:15:29.3007699+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "9df4456a-694b-452a-9626-a8ef1b219bd1",
    "sales_organization": {
      "id": "cc13ce3f-35c0-4e8a-91a2-39d4d00e7287",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "90e1efaf-7686-4cf4-b065-976d0efa8884",
      "db_currency_id": "ff96b2c8-e13c-45d4-824f-0ee2286dd5ec",
      "db_language_id": "87f4dc5d-abf4-4b40-9748-f51e46f34e5d",
      "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-06-11T10:15:29.3007699+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "09529727-2f47-44b1-8961-399a817b6f3d",
    "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": "78526e1a-ae46-4d90-a4b6-08cf9935b6a1",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-06-11T10:15:29.3007699+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "c22d9745-4de5-4f40-b3ca-1c372f5e9018"
  },
  "user_unavailability_type_id": "268f4731-f499-436e-b93f-adb1827018b6",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "1734544c-9e7a-41e8-a2ed-e8b363ac8a97",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "f26baa34-e7a4-4d52-81ed-992d39899b18",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "cc13ce3f-35c0-4e8a-91a2-39d4d00e7287",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "90e1efaf-7686-4cf4-b065-976d0efa8884",
      "db_currency_id": "ff96b2c8-e13c-45d4-824f-0ee2286dd5ec",
      "db_language_id": "87f4dc5d-abf4-4b40-9748-f51e46f34e5d",
      "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-06-11T10:15:29.3007699+00:00"
    },
    "modified_dateutc": "2026-06-11T10:15:29.3007699+00:00"
  }
}