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": "41af20ad-cef0-49b6-84f5-3798ec6f12cf",
  "date_start": "2026-03-12T06:13:12.5887428+00:00",
  "date_end": "2026-03-12T06:13:12.5887428+00:00",
  "modified_dateutc": "2026-03-12T06:13:12.5887428+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "b605e043-28c0-4af3-a031-cc53f2fae9d9",
  "user_code": "sample string 8",
  "user": {
    "id": "9a581d7a-f19e-4e1b-baaf-84884080df5d",
    "db_language_id": "292c1676-f63b-49ef-9d16-8a469692be8b",
    "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-03-12T06:13:12.5887428+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "6a3b9cf1-981a-44f3-89dc-371cdac0f38e",
    "sales_organization": {
      "id": "c7537e6d-6e45-44c6-b17d-09b4f19ae2f5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "cf8be3c1-bffa-43c9-b0f6-542706d7d551",
      "db_currency_id": "c6c4fcae-1c95-442b-99b4-3402005f428c",
      "db_language_id": "ed1ba42b-583e-428b-99d2-66def5fdb35f",
      "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-03-12T06:13:12.5887428+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "93c0ffe9-2391-4e02-92c3-0ed1041c6a70",
    "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": "6722cfe1-a3b8-44d7-b2e9-6e24f257e89b",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-03-12T06:13:12.5887428+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "0e77109f-9f44-40e5-b307-2e73b373cdd8"
  },
  "user_unavailability_type_id": "a00caf09-f610-4bd6-89d9-761f7b965ef5",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "295acb5f-f604-4ece-8ad7-e084b5e7fdc0",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "e2d16914-30f2-4117-abcc-2df5269121e8",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "c7537e6d-6e45-44c6-b17d-09b4f19ae2f5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "cf8be3c1-bffa-43c9-b0f6-542706d7d551",
      "db_currency_id": "c6c4fcae-1c95-442b-99b4-3402005f428c",
      "db_language_id": "ed1ba42b-583e-428b-99d2-66def5fdb35f",
      "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-03-12T06:13:12.5887428+00:00"
    },
    "modified_dateutc": "2026-03-12T06:13:12.5887428+00:00"
  }
}