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": "5905aff3-33e3-4ffc-8266-5e161e65aae5",
  "date_start": "2025-11-04T13:30:52.0508247+00:00",
  "date_end": "2025-11-04T13:30:52.0508247+00:00",
  "modified_dateutc": "2025-11-04T13:30:52.0508247+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "c73dbdc7-841f-4896-932e-98970e1925ef",
  "user_code": "sample string 8",
  "user": {
    "id": "b152d460-c5e4-4751-896b-37ced9b60757",
    "db_language_id": "ff63dac1-f553-42fe-b082-a6daf4e3fd9c",
    "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-11-04T13:30:52.0508247+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "d855bfd7-28ac-4e4e-87e1-e7d342f6ee49",
    "sales_organization": {
      "id": "f8fd14c8-5f19-4518-b044-493ea8d7e087",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "3956a23a-73b3-45ef-8eab-12bd957d4e4f",
      "db_currency_id": "a2300cf1-9c01-434a-840e-cc8cfc232623",
      "db_language_id": "5808a4c3-2f19-41ff-bac0-234bd501cd64",
      "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-11-04T13:30:52.0508247+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "d3061448-c0dd-4f24-be4e-eb5f4767d7c9",
    "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": "d0c54d97-67b2-4f39-8035-8c6f9c528e1d",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-11-04T13:30:52.0508247+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "0fb925d6-50f9-46b8-81d6-875edd4c4ecb"
  },
  "user_unavailability_type_id": "2b91f9db-8758-4bac-8e2e-e5f5e37cb3cb",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "c2ed830b-9980-4bcb-bc45-dcc035c0c76b",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "4d029526-95e9-482e-9e6b-5d3d96233939",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "f8fd14c8-5f19-4518-b044-493ea8d7e087",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "3956a23a-73b3-45ef-8eab-12bd957d4e4f",
      "db_currency_id": "a2300cf1-9c01-434a-840e-cc8cfc232623",
      "db_language_id": "5808a4c3-2f19-41ff-bac0-234bd501cd64",
      "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-11-04T13:30:52.0508247+00:00"
    },
    "modified_dateutc": "2025-11-04T13:30:52.0508247+00:00"
  }
}