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": "f0c21c3d-fccb-40a4-8d16-3b2177cebcf4",
  "date_start": "2025-09-15T23:14:15.434456+00:00",
  "date_end": "2025-09-15T23:14:15.434456+00:00",
  "modified_dateutc": "2025-09-15T23:14:15.434456+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "18e66609-d3b8-48a7-80e9-001b433e6bfa",
  "user_code": "sample string 8",
  "user": {
    "id": "d2470011-18c5-446d-8e06-b04b931d45f7",
    "db_language_id": "3f69ee8e-7060-42cc-bcd3-66cd52c47867",
    "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-09-15T23:14:15.434456+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "c9b0bd7e-e4ca-4079-ab7b-87101fa3ee01",
    "sales_organization": {
      "id": "3d160a96-19cb-4961-be3f-c0ecb4ed4490",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5d1a5013-2b4e-43a4-935a-2e15a06f86ec",
      "db_currency_id": "5bfbfe8a-ffe7-4c19-af92-2f0a49dc33d2",
      "db_language_id": "2b625fa1-6172-4dcc-9c9b-8ebfc5a4ac8a",
      "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-09-15T23:14:15.434456+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "4e80d7c1-d2e7-4c8d-b710-5d33d587a7e5",
    "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": "f8d60f1b-d66f-4e3d-88f9-f189ee44f246",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-09-15T23:14:15.434456+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "30dc3df8-1977-46b7-99f7-e47a4859e0ce"
  },
  "user_unavailability_type_id": "d2e256cd-cbfc-4a5f-ba6c-38b381bf0dcc",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "bd505099-e66e-4904-8081-e14c9542ab6b",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "7897a377-77a1-4cb7-a777-eb0e2b7d3444",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "3d160a96-19cb-4961-be3f-c0ecb4ed4490",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5d1a5013-2b4e-43a4-935a-2e15a06f86ec",
      "db_currency_id": "5bfbfe8a-ffe7-4c19-af92-2f0a49dc33d2",
      "db_language_id": "2b625fa1-6172-4dcc-9c9b-8ebfc5a4ac8a",
      "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-09-15T23:14:15.434456+00:00"
    },
    "modified_dateutc": "2025-09-15T23:14:15.434456+00:00"
  }
}