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": "c60697cf-3516-4e9a-96f9-631f7679b855",
  "date_start": "2026-08-02T14:49:58.6035446+00:00",
  "date_end": "2026-08-02T14:49:58.6035446+00:00",
  "modified_dateutc": "2026-08-02T14:49:58.6035446+00:00",
  "description": "sample string 5",
  "is_approved": true,
  "user_id": "6d0d9133-5f02-4a6a-9394-16f4fef8fc35",
  "user_code": "sample string 8",
  "user": {
    "id": "41456eff-4f3b-4df2-a0b1-d75d44fc26eb",
    "db_language_id": "e224deb2-698b-4d0c-a134-0c83d176f40f",
    "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-08-02T14:49:58.6035446+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "c0bbd9e7-7553-49db-a3e2-502b42e02827",
    "sales_organization": {
      "id": "70e2ef6d-c3ae-4925-8d28-c956799639d5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b5b8983a-f776-4e8e-83c7-69e88d1800a0",
      "db_currency_id": "84774c96-ec85-4464-bcd5-a7036dbd3008",
      "db_language_id": "ee0d653d-5268-4ae9-9701-2e61fa672692",
      "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-08-02T14:49:58.6035446+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "8dce91af-09af-418b-a230-15677b01a930",
    "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": "5eb14eab-1cc4-46cd-bde6-618f25074194",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2026-08-02T14:49:58.6035446+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "3407e27b-a992-4b7b-b792-ec8e5c2c8b40"
  },
  "user_unavailability_type_id": "85855501-2ab8-4b75-bd3d-ff75cfef4ff2",
  "user_unavailability_type_code": "sample string 10",
  "user_unavailability_type": {
    "id": "042366eb-09f9-4bdc-b435-3038ef3d7eb3",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "sales_organization_id": "fa466af7-ec00-4995-a19b-556e2d582973",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "70e2ef6d-c3ae-4925-8d28-c956799639d5",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "b5b8983a-f776-4e8e-83c7-69e88d1800a0",
      "db_currency_id": "84774c96-ec85-4464-bcd5-a7036dbd3008",
      "db_language_id": "ee0d653d-5268-4ae9-9701-2e61fa672692",
      "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-08-02T14:49:58.6035446+00:00"
    },
    "modified_dateutc": "2026-08-02T14:49:58.6035446+00:00"
  }
}