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": "171fd4d0-3781-488a-806b-c7cebd9a0b5c",
  "date_start": "2026-09-04T01:41:26.7204133+00:00",
  "date_end": "2026-09-04T01:41:26.7204133+00:00",
  "modified_dateutc": "2026-09-04T01:41:26.7204133+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "42e8c40c-8a30-4377-a3df-31dbe7157706",
  "user_code": "sample string 8",
  "user": {
    "id": "200ade00-a83c-4e55-b4e0-80156971e254",
    "db_language_id": "ab5f6fcd-f79b-44da-ae7d-69a1ef8b029d",
    "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-04T01:41:26.7204133+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "451fef2b-5b63-4281-b9dd-6ac8a0bfedbc",
    "sales_organization": {
      "id": "6c010173-6c90-4c1f-9e2c-d8e314c2f249",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "65d55198-e004-4e69-8f02-33055a639018",
      "db_currency_id": "3eb48227-62cc-49a1-b466-999e1785e58d",
      "db_language_id": "f8791151-9622-4770-b98f-3b54172d682e",
      "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-04T01:41:26.7204133+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "7ece707f-d005-4106-9628-276904577f9f",
    "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": "6995c6b5-2b25-40d6-9f39-52e822dc86bf",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-09-04T01:41:26.7204133+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "c7654c52-0aa7-4046-928d-2bf1f1f967ac"
  },
  "user_unavailability_type_id": "1f16e94f-18c5-4b46-ad08-3b9159674eea",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "7ff5ef79-3df1-47ec-b33b-79278036f7c1",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "4d26caff-1874-4a80-9521-f85e1e19c6da",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "6c010173-6c90-4c1f-9e2c-d8e314c2f249",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "65d55198-e004-4e69-8f02-33055a639018",
      "db_currency_id": "3eb48227-62cc-49a1-b466-999e1785e58d",
      "db_language_id": "f8791151-9622-4770-b98f-3b54172d682e",
      "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-04T01:41:26.7204133+00:00"
    },
    "modified_dateutc": "2026-09-04T01:41:26.7204133+00:00"
  }
}