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": "fd118033-b96c-401c-9858-a2daafb03ca3",
  "date_start": "2026-02-03T02:34:17.2493071+00:00",
  "date_end": "2026-02-03T02:34:17.2493071+00:00",
  "modified_dateutc": "2026-02-03T02:34:17.2493071+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "06fba5e4-a684-4553-a24b-19ed1342ca57",
  "user_code": "sample string 8",
  "user": {
    "id": "56bcd402-c978-446e-9b90-522dc4a58c15",
    "db_language_id": "6cdad395-6eeb-4c94-bb87-77d0db7e89a4",
    "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-02-03T02:34:17.2649329+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "2669ae7f-4a12-494f-84d6-7cb48db8ae6c",
    "sales_organization": {
      "id": "d0557089-4ac0-43d8-9abd-e7b5ffaef77a",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "63f0a7b6-46f0-4f2b-b7f4-22b0c8166ada",
      "db_currency_id": "60d3e850-9912-46d5-bb0e-a48ba286d04b",
      "db_language_id": "068dbf02-2bf1-48ac-b09d-42bf7f487e6c",
      "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-02-03T02:34:17.2649329+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "e7d76b9c-a9fc-4a71-9023-e555bd3fff16",
    "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": "8457e725-4b33-4574-bcf1-e0482e086e19",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-02-03T02:34:17.2649329+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "11295119-9582-4541-805e-f508051a6401"
  },
  "user_unavailability_type_id": "257b7f35-80df-4ee6-8b39-1b58dd579a9f",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "47f97595-480b-4a43-b263-b7366082cae6",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "31488b85-56ce-467d-b394-2f269a6fc1d3",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "d0557089-4ac0-43d8-9abd-e7b5ffaef77a",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "63f0a7b6-46f0-4f2b-b7f4-22b0c8166ada",
      "db_currency_id": "60d3e850-9912-46d5-bb0e-a48ba286d04b",
      "db_language_id": "068dbf02-2bf1-48ac-b09d-42bf7f487e6c",
      "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-02-03T02:34:17.2649329+00:00"
    },
    "modified_dateutc": "2026-02-03T02:34:17.2649329+00:00"
  }
}