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": "a1f7592c-4e9b-4bb5-9287-5f1ead78f01c",
  "date_start": "2025-12-18T17:13:41.5587722+00:00",
  "date_end": "2025-12-18T17:13:41.5587722+00:00",
  "modified_dateutc": "2025-12-18T17:13:41.5587722+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "323bcee1-dfe0-4020-8d16-c9431e7fb048",
  "user_code": "sample string 8",
  "user": {
    "id": "be81d1d1-4aec-435e-8f7d-b15b16a0661b",
    "db_language_id": "487fa5bb-9a0b-4c27-8259-e8ec6d401abc",
    "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-12-18T17:13:41.5587722+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "9f202588-825c-43db-8494-499734cd41d7",
    "sales_organization": {
      "id": "12f4f654-d8d4-4c39-bcac-bbe0729f4a60",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b795abdc-6f49-4cea-a3f3-1723a18b01b9",
      "db_currency_id": "ff289a6d-568a-4afd-a932-3166dbbd0e8f",
      "db_language_id": "bcc3d6d1-37ab-4572-93bb-c3bd7225acef",
      "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-12-18T17:13:41.5587722+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "588ed261-9aad-4509-bd32-9404c41e6d65",
    "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": "e450a65b-d868-4408-95c0-5724ba6bbc7a",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-12-18T17:13:41.5743941+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "13270671-852d-4bc3-8a76-67674c34b476"
  },
  "user_unavailability_type_id": "6122c665-b98e-4845-b97d-efa3ab636692",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "22b54ee7-c310-4d55-9afa-e25f1b45393f",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "93ee33d7-b50f-44a5-9b94-b68d17136697",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "12f4f654-d8d4-4c39-bcac-bbe0729f4a60",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b795abdc-6f49-4cea-a3f3-1723a18b01b9",
      "db_currency_id": "ff289a6d-568a-4afd-a932-3166dbbd0e8f",
      "db_language_id": "bcc3d6d1-37ab-4572-93bb-c3bd7225acef",
      "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-12-18T17:13:41.5587722+00:00"
    },
    "modified_dateutc": "2025-12-18T17:13:41.5743941+00:00"
  }
}