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": "6062b8e5-c397-4345-ae56-19bc4f9fc125",
  "date_start": "2025-11-29T03:42:07.3906321+00:00",
  "date_end": "2025-11-29T03:42:07.3906321+00:00",
  "modified_dateutc": "2025-11-29T03:42:07.3906321+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "e7de1654-59ff-4906-a078-fcfbdc92cc4a",
  "user_code": "sample string 8",
  "user": {
    "id": "b486508b-df33-4129-a967-3dadb8b5f527",
    "db_language_id": "f5a928bc-bd1d-488d-a0f0-fcdf7c097939",
    "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-29T03:42:07.3906321+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "19cb1b8f-22b4-47de-8b95-aa4306da3193",
    "sales_organization": {
      "id": "bb6f2866-2de1-4756-9831-70a730c8e1e9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "e324dafb-18af-42e9-8d5c-0d22e1c8ec98",
      "db_currency_id": "fd24b3c4-cad9-4dea-98a9-2a3452447c68",
      "db_language_id": "19f1bc71-fb0d-45b1-b60a-94e6164d71ca",
      "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-29T03:42:07.3906321+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "006074fc-31d4-458a-8703-3223a51d6118",
    "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": "c54c1c08-2d50-48e0-b002-0955bf5ba4bf",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-11-29T03:42:07.3906321+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "c4051d14-e024-4428-abc7-fd6e0d676f33"
  },
  "user_unavailability_type_id": "a2a678ac-60c6-49f7-97b1-3d43bef349ea",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "6e636204-b65e-4d3f-9705-3d38ae9e42e5",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "8d10ba5b-fd74-4866-97ee-65477bcff9a7",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "bb6f2866-2de1-4756-9831-70a730c8e1e9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "e324dafb-18af-42e9-8d5c-0d22e1c8ec98",
      "db_currency_id": "fd24b3c4-cad9-4dea-98a9-2a3452447c68",
      "db_language_id": "19f1bc71-fb0d-45b1-b60a-94e6164d71ca",
      "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-29T03:42:07.3906321+00:00"
    },
    "modified_dateutc": "2025-11-29T03:42:07.3906321+00:00"
  }
}