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": "5b7cb5e1-b2e8-42ec-9680-edad1de862b5",
  "date_start": "2026-04-18T04:24:36.5178393+00:00",
  "date_end": "2026-04-18T04:24:36.5178393+00:00",
  "modified_dateutc": "2026-04-18T04:24:36.5178393+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "30a0805e-811c-484d-9610-2ebacbe8aa00",
  "user_code": "sample string 8",
  "user": {
    "id": "d115866b-eb71-4dbe-8620-be6b531819f1",
    "db_language_id": "9217bf9a-bfb9-413f-95c0-565443ecf354",
    "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-04-18T04:24:36.5178393+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "a839f130-f1bc-4170-a056-6e4b4557fd24",
    "sales_organization": {
      "id": "91bb5fac-bcac-45a6-9a8c-fe9e3335d5c9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d12e69ea-d613-477c-b294-921d89897966",
      "db_currency_id": "7e269717-a9e0-4145-a0c5-cfa4c4d84792",
      "db_language_id": "8521b2cd-9f52-4ba5-be75-e30b30560bb6",
      "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-04-18T04:24:36.5178393+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "759be1b2-fb7f-4835-a772-9d5efead5905",
    "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": "8f29f43f-f860-45e2-9489-f2aa1efcfd7e",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-04-18T04:24:36.5178393+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "cbab8ecb-b889-4a89-a37c-27e709dce27e"
  },
  "user_unavailability_type_id": "d1f44553-1463-43e3-b3a4-7d8fd8fbedaa",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "055079ca-c19e-49ae-889e-e3102be786bf",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "f3774096-a717-4a99-b5a3-0bebce07cc14",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "91bb5fac-bcac-45a6-9a8c-fe9e3335d5c9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d12e69ea-d613-477c-b294-921d89897966",
      "db_currency_id": "7e269717-a9e0-4145-a0c5-cfa4c4d84792",
      "db_language_id": "8521b2cd-9f52-4ba5-be75-e30b30560bb6",
      "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-04-18T04:24:36.5178393+00:00"
    },
    "modified_dateutc": "2026-04-18T04:24:36.5178393+00:00"
  }
}