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": "12f825ef-5b31-410a-8bd5-77e92a7ac2f6",
  "date_start": "2025-11-17T17:35:00.622346+00:00",
  "date_end": "2025-11-17T17:35:00.6379672+00:00",
  "modified_dateutc": "2025-11-17T17:35:00.6379672+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "4187c9ba-3114-45f3-b819-5c9e8bda3af2",
  "user_code": "sample string 8",
  "user": {
    "id": "3e3d8b5a-e838-417a-a87a-e221df27cd8e",
    "db_language_id": "431b5ec1-a1ff-4ef1-91a6-5d582ab8443f",
    "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-11-17T17:35:00.6379672+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "e439b83b-2355-405e-819c-6250687a64f6",
    "sales_organization": {
      "id": "fb3d3045-da60-47e9-917a-e3a535dacbf8",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b2b35a03-c384-43bf-a456-493f73d05056",
      "db_currency_id": "96c7b720-3661-414b-b59c-ca4d0928fe5d",
      "db_language_id": "fa302a85-7150-40f2-baf9-49593139957d",
      "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-11-17T17:35:00.6379672+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "2d1c7503-f2a2-4f4e-b70b-aedff81868b2",
    "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": "1ccc6f63-ab82-4c56-8551-74d6ae0499ed",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-11-17T17:35:00.6379672+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "e86ae0f2-3e95-4be4-a706-12bb8dae0aeb"
  },
  "user_unavailability_type_id": "07df50e3-e83c-4811-9e30-46ef4dcc751d",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "36e92619-fa04-4494-940e-4da353e05554",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "629d3fa6-fb84-421e-a2da-c61ec3e359bb",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "fb3d3045-da60-47e9-917a-e3a535dacbf8",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b2b35a03-c384-43bf-a456-493f73d05056",
      "db_currency_id": "96c7b720-3661-414b-b59c-ca4d0928fe5d",
      "db_language_id": "fa302a85-7150-40f2-baf9-49593139957d",
      "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-11-17T17:35:00.6379672+00:00"
    },
    "modified_dateutc": "2025-11-17T17:35:00.6379672+00:00"
  }
}