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": "c03a3e3d-cbc4-449c-835d-091af86298ed",
  "date_start": "2025-10-10T00:44:26.2054478+00:00",
  "date_end": "2025-10-10T00:44:26.2054478+00:00",
  "modified_dateutc": "2025-10-10T00:44:26.2054478+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "4db5a7f9-3482-454d-8e69-25d6a4606378",
  "user_code": "sample string 8",
  "user": {
    "id": "da8dd155-886c-485b-9f7f-543444a80c37",
    "db_language_id": "3c8746b2-673b-47f1-b1b2-5c77ea98f6de",
    "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-10-10T00:44:26.2054478+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "89ddc065-8fef-4b55-8ad4-b76c765053c7",
    "sales_organization": {
      "id": "4ab61d3d-4ad3-4604-968e-a630715fbfd8",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "de890acb-257c-43d9-8ed7-662f1e4480ff",
      "db_currency_id": "5fb49a54-8a74-4fb9-9e79-331abad22206",
      "db_language_id": "372edc90-fa5d-4aaa-b7a5-bc55b32ce322",
      "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-10-10T00:44:26.2054478+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "5d0e1ca8-2f51-4a54-837c-46c38642892b",
    "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": "ecae2740-e591-4217-b505-fb19df1b16a1",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-10-10T00:44:26.2054478+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "d6553215-8973-42ee-af00-ecf10fef0412"
  },
  "user_unavailability_type_id": "aa83743d-a927-46ed-add7-74a89108cb51",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "c19a5ef5-3e85-40fe-abc0-7fdb5ad3199f",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "f4a57bac-f500-46ad-a50b-2e25e7b74212",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "4ab61d3d-4ad3-4604-968e-a630715fbfd8",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "de890acb-257c-43d9-8ed7-662f1e4480ff",
      "db_currency_id": "5fb49a54-8a74-4fb9-9e79-331abad22206",
      "db_language_id": "372edc90-fa5d-4aaa-b7a5-bc55b32ce322",
      "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-10-10T00:44:26.2054478+00:00"
    },
    "modified_dateutc": "2025-10-10T00:44:26.2054478+00:00"
  }
}