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": "b01dba95-bd5a-4b38-a3cb-df7dde327d77",
  "date_start": "2026-09-22T08:12:40.3150156+00:00",
  "date_end": "2026-09-22T08:12:40.3150156+00:00",
  "modified_dateutc": "2026-09-22T08:12:40.3150156+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "1856c2e8-1db3-457f-af4c-31ccefd3467f",
  "user_code": "sample string 8",
  "user": {
    "id": "c6cf4d3b-e874-4d06-848d-28ec62aaf2f6",
    "db_language_id": "db4bc581-c932-4f56-bde9-f1a94066ef24",
    "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-09-22T08:12:40.3150156+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "d658422a-42d3-4b93-b343-feb26ab3bf93",
    "sales_organization": {
      "id": "da8e5011-734e-4240-a262-5965a43f6034",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "32341ad5-e77d-4d03-a971-3bd35b9947e8",
      "db_currency_id": "7e97af5b-2117-42af-ae08-a75711259f3a",
      "db_language_id": "d7d0dbd3-e6d6-4ba2-ad91-0a35c83518ee",
      "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-09-22T08:12:40.3150156+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "3ead2810-5d8b-461d-9f62-60da4edfdf44",
    "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": "ce76624f-2e46-48a8-876d-3f15961008cb",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-09-22T08:12:40.3150156+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "291e5c6a-eadd-4452-810f-7e02e240021d"
  },
  "user_unavailability_type_id": "29212d1c-3a29-4c17-8915-4f1f48a4cfee",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "9699c89c-ddea-4451-ae16-1123d7c757ef",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "80f9b7ef-ed23-4372-9ff7-b659e7bb72d7",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "da8e5011-734e-4240-a262-5965a43f6034",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "32341ad5-e77d-4d03-a971-3bd35b9947e8",
      "db_currency_id": "7e97af5b-2117-42af-ae08-a75711259f3a",
      "db_language_id": "d7d0dbd3-e6d6-4ba2-ad91-0a35c83518ee",
      "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-09-22T08:12:40.3150156+00:00"
    },
    "modified_dateutc": "2026-09-22T08:12:40.3150156+00:00"
  }
}