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": "ec72c05d-af56-447d-8bff-f5a8134b8694",
  "date_start": "2026-04-03T03:16:33.2714916+00:00",
  "date_end": "2026-04-03T03:16:33.2714916+00:00",
  "modified_dateutc": "2026-04-03T03:16:33.2714916+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "4e9a2349-0f48-4221-b291-7d0a6684ee9a",
  "user_code": "sample string 8",
  "user": {
    "id": "a831c155-9203-41c0-8053-2c38b6846c38",
    "db_language_id": "85fa9d6b-8cdf-4130-b272-55250467bf16",
    "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-03T03:16:33.2714916+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "65720f6c-3b36-453a-bc9d-8c4391929513",
    "sales_organization": {
      "id": "a6801f8e-8cab-4a63-97e6-4d5a7dbf45d6",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "189ce782-d45e-445e-a518-3f935f525a78",
      "db_currency_id": "2a649731-5d4a-4338-a235-9d5fae4f88a3",
      "db_language_id": "6c5f4886-9d20-4812-89ae-c971a83d7776",
      "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-03T03:16:33.2714916+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "594030ae-c5ef-4570-b074-f254bf44e2e1",
    "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": "4cec3f51-39c3-468b-9f63-a03dc1141216",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-04-03T03:16:33.2714916+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "ff8a858e-5829-4df1-a9b4-7ff827d0f443"
  },
  "user_unavailability_type_id": "19938e77-11d6-4cce-ad6b-1169ea8261b9",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "00ebb3c7-86c4-4b34-8ab4-586d40f9f90f",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "5ed02595-5263-46ef-9522-8a9909d14d3f",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "a6801f8e-8cab-4a63-97e6-4d5a7dbf45d6",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "189ce782-d45e-445e-a518-3f935f525a78",
      "db_currency_id": "2a649731-5d4a-4338-a235-9d5fae4f88a3",
      "db_language_id": "6c5f4886-9d20-4812-89ae-c971a83d7776",
      "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-03T03:16:33.2714916+00:00"
    },
    "modified_dateutc": "2026-04-03T03:16:33.2714916+00:00"
  }
}