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": "1292f053-296d-4973-bc8e-16a3e7b34c1a",
  "date_start": "2025-08-12T12:34:55.6269096+00:00",
  "date_end": "2025-08-12T12:34:55.6269096+00:00",
  "modified_dateutc": "2025-08-12T12:34:55.6269096+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "e5743e17-02ec-4002-b02b-55e1e658e01d",
  "user_code": "sample string 8",
  "user": {
    "id": "6af4d579-23fa-4d41-94d5-73e9d9283dab",
    "db_language_id": "78e4159d-71f3-42c1-b23e-7fc8045dea1d",
    "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-08-12T12:34:55.6269096+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "86f9a36e-10c8-4509-9c3c-82cd9de95640",
    "sales_organization": {
      "id": "952ba768-b9a3-4b63-a16b-0f80e9f695c7",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "03bf9cff-dfb9-44e9-868f-ee44ead79911",
      "db_currency_id": "f9f48f8e-d3a0-4e12-92d6-4e1bbf827060",
      "db_language_id": "deb0dd29-571d-46fb-8380-033f5e015b46",
      "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-08-12T12:34:55.6269096+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "597f0a0b-df04-4349-b510-fab043bfb0e9",
    "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": "4d6f3f4a-22d0-4807-8f43-0d75268654cc",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-08-12T12:34:55.6269096+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "6744902f-74d5-4e4e-a393-23686acda02b"
  },
  "user_unavailability_type_id": "fb479454-a9da-4fad-a582-82ac54119ec5",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "0924d94e-a0b9-45cb-b02a-5d74472b66b8",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "3637967c-3f40-4dc8-b675-0748bcd9546b",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "952ba768-b9a3-4b63-a16b-0f80e9f695c7",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "03bf9cff-dfb9-44e9-868f-ee44ead79911",
      "db_currency_id": "f9f48f8e-d3a0-4e12-92d6-4e1bbf827060",
      "db_language_id": "deb0dd29-571d-46fb-8380-033f5e015b46",
      "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-08-12T12:34:55.6269096+00:00"
    },
    "modified_dateutc": "2025-08-12T12:34:55.6269096+00:00"
  }
}