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": "e7b92ab5-8daf-4fb1-9350-da50b1a10b41",
  "date_start": "2026-05-13T11:35:26.2716718+00:00",
  "date_end": "2026-05-13T11:35:26.2716718+00:00",
  "modified_dateutc": "2026-05-13T11:35:26.2716718+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "ff509406-c567-4aef-a007-788e0a198198",
  "user_code": "sample string 8",
  "user": {
    "id": "b66b7f3d-e77d-4a3f-95ff-b0e1c3813153",
    "db_language_id": "ab26dc89-83c2-4a2b-bd56-7179557c458d",
    "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-05-13T11:35:26.2716718+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "6caa1f66-8cca-44a4-a200-d5240fa11eac",
    "sales_organization": {
      "id": "5b9cbbd5-5214-4f31-a458-b62e034d38b5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d7dc99b1-4825-4ce0-8674-7236b3d1fcda",
      "db_currency_id": "57b8d271-bfcb-46b1-bb81-50c39a918c9b",
      "db_language_id": "a09c02d6-472c-44c5-9c28-d378b856bd80",
      "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-05-13T11:35:26.2716718+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "6b99f2aa-2e22-492a-82d0-57597a824b3c",
    "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": "cabd3207-3576-4b44-8c2f-22f35ee5f5be",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-05-13T11:35:26.2716718+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "cd4ab553-4492-415a-b22c-5b374c9d4baf"
  },
  "user_unavailability_type_id": "846f411a-3f42-4742-9284-bf9f604585bf",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "9557f14d-f746-4517-a4a4-a8d680e40b73",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "05b0825b-26ba-462f-a435-b7b3ba3f4931",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "5b9cbbd5-5214-4f31-a458-b62e034d38b5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "d7dc99b1-4825-4ce0-8674-7236b3d1fcda",
      "db_currency_id": "57b8d271-bfcb-46b1-bb81-50c39a918c9b",
      "db_language_id": "a09c02d6-472c-44c5-9c28-d378b856bd80",
      "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-05-13T11:35:26.2716718+00:00"
    },
    "modified_dateutc": "2026-05-13T11:35:26.2716718+00:00"
  }
}