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": "b45f6e02-2c93-42e4-88bc-d4d42d049733",
  "date_start": "2025-10-01T05:25:16.9814057+00:00",
  "date_end": "2025-10-01T05:25:16.9814057+00:00",
  "modified_dateutc": "2025-10-01T05:25:16.9814057+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "e08f4d2f-47f4-40fd-8e47-dfe49b072b5e",
  "user_code": "sample string 8",
  "user": {
    "id": "85810a16-c1e9-4365-9c2e-f48c5e16a79a",
    "db_language_id": "daba590d-263e-4419-a58c-fe651c8e21de",
    "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-10-01T05:25:16.9814057+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "5078039d-9854-4b28-839f-da76b5e82bad",
    "sales_organization": {
      "id": "41d220d9-d3d3-4142-9006-9172c71fef10",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "786e3a24-2484-4d2c-96ab-9f40766d5e90",
      "db_currency_id": "fadb9135-b242-400b-8afb-b942efd33c68",
      "db_language_id": "da8a9244-ccfb-43f6-8bb7-9b2c1abc9769",
      "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-10-01T05:25:16.9814057+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "1aa3b98e-49f2-4335-b107-61c96735f5d4",
    "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": "cb42d1d8-77c8-4cf0-ae36-adfb1d34550c",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-10-01T05:25:16.9814057+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "bf55edc5-bcd5-4da3-b1ac-f863b0926c05"
  },
  "user_unavailability_type_id": "0bc09f53-0461-4631-a8a9-d8de7cf8a48b",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "9625f6bc-01ef-4729-ae92-914bfc71fb32",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "ed22cf04-89c6-4a1c-86dc-2631179a6e7c",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "41d220d9-d3d3-4142-9006-9172c71fef10",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "786e3a24-2484-4d2c-96ab-9f40766d5e90",
      "db_currency_id": "fadb9135-b242-400b-8afb-b942efd33c68",
      "db_language_id": "da8a9244-ccfb-43f6-8bb7-9b2c1abc9769",
      "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-10-01T05:25:16.9814057+00:00"
    },
    "modified_dateutc": "2025-10-01T05:25:16.9814057+00:00"
  }
}