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": "2794ef26-3a23-4d9f-9fcd-feba9ec3c74a",
  "date_start": "2026-10-10T02:19:22.6763598+00:00",
  "date_end": "2026-10-10T02:19:22.6763598+00:00",
  "modified_dateutc": "2026-10-10T02:19:22.6763598+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "dd46061c-6083-4c91-8078-8d44ca3ec889",
  "user_code": "sample string 8",
  "user": {
    "id": "2714390f-f527-4029-8aef-23fad74b6631",
    "db_language_id": "f957df97-3e85-40c0-a6dc-708d425a6214",
    "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-10-10T02:19:22.6763598+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "4276be66-23a5-422b-a24d-88e83d8fa301",
    "sales_organization": {
      "id": "44709dea-2f54-4090-bd64-59aec85003e0",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "621d2088-727d-4782-ab1c-688d7b3ff65f",
      "db_currency_id": "8cb0b44f-3f68-4bff-b278-373329ba55a2",
      "db_language_id": "dd3ac820-7ada-4146-aa6f-933b65202be4",
      "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-10-10T02:19:22.6763598+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "2bf5fa63-71c5-44dc-81a7-56e4751e29d9",
    "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": "94e8540b-42c1-41f4-b74e-e66dd4911382",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-10-10T02:19:22.6763598+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "a7962025-67b7-4f32-b0a2-0e664d6b511b"
  },
  "user_unavailability_type_id": "a99dc34c-61d2-4a0f-a4fc-795e9fecd10e",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "98023816-df4e-48c8-b28d-95c633bc21ad",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "72b35814-e13a-451b-8ca9-41bc5acd6f98",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "44709dea-2f54-4090-bd64-59aec85003e0",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "621d2088-727d-4782-ab1c-688d7b3ff65f",
      "db_currency_id": "8cb0b44f-3f68-4bff-b278-373329ba55a2",
      "db_language_id": "dd3ac820-7ada-4146-aa6f-933b65202be4",
      "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-10-10T02:19:22.6763598+00:00"
    },
    "modified_dateutc": "2026-10-10T02:19:22.6763598+00:00"
  }
}