Retrieves the user unavailability period with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The user unavailability period id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the user unavailability period, or 404 Not Found if it doesn't exist.
user_unavailability| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| date_start |
Date+Time of the beginning |
date |
Required |
| date_end |
Date+Time of the end |
date |
Required |
| user_unavailability_type_id |
Foreign key of the type of unavailability (see ). |
globally unique identifier | |
| user_unavailability_type_name |
Display name of the unavailability type (denormalized copy of the type record). |
string | |
| description |
Description |
string |
Max length: 255 |
| sys_logical_delete |
Logical delete |
boolean | |
| user_id |
Assigned user |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| is_approved |
is_approved |
boolean | |
| user_week_approval_id |
user_week_approval_id |
globally unique identifier | |
| db_address_id |
db_address_id |
globally unique identifier | |
| location |
location |
string |
Max length: 50 |
| holiday_id |
holiday_id |
globally unique identifier | |
| archive_reason |
archive_reason |
string |
Max length: 4000 |
| recurrence_id |
recurrence_id |
globally unique identifier | |
| time_span |
time_span |
string |
Max length: 255 |
| dateutc_create |
Readonly system field: UTC date and time this unavailability record was created. |
date | |
| is_confirmed |
comfirmed by the user |
boolean |
Response Formats
application/json, text/json
{
"id": "9ede7d10-6678-4a8d-94b2-87110c5f0675",
"date_start": "2026-09-16T11:02:33.331681+00:00",
"date_end": "2026-09-16T11:02:33.331681+00:00",
"user_unavailability_type_id": "0349da47-e339-400d-827e-e9fafda5aa53",
"user_unavailability_type_name": "sample string 5",
"description": "sample string 6",
"sys_logical_delete": true,
"user_id": "bcc3dd15-ae4d-4b15-8118-3bb8d444dd4b",
"modified_dateutc": "2026-09-16T11:02:33.331681+00:00",
"is_approved": true,
"user_week_approval_id": "358bf99a-45a2-4636-924e-153fda7372c9",
"db_address_id": "272a10b9-ffcf-4d61-ac6f-e0b4f6a37929",
"location": "sample string 13",
"holiday_id": "e8e54005-5498-4453-a383-0afc2d5b85d2",
"archive_reason": "sample string 15",
"recurrence_id": "4ddeef25-f8d0-4253-ae75-6de0328fd836",
"time_span": "sample string 17",
"dateutc_create": "2026-09-16T11:02:33.331681+00:00",
"is_confirmed": true
}
application/xml, text/xml
<user_unavailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archive_reason>sample string 15</archive_reason> <date_end>2026-09-16T11:02:33.331Z</date_end> <date_start>2026-09-16T11:02:33.331Z</date_start> <dateutc_create>2026-09-16T11:02:33.331Z</dateutc_create> <db_address_id>272a10b9-ffcf-4d61-ac6f-e0b4f6a37929</db_address_id> <description>sample string 6</description> <holiday_id>e8e54005-5498-4453-a383-0afc2d5b85d2</holiday_id> <id>9ede7d10-6678-4a8d-94b2-87110c5f0675</id> <is_approved>true</is_approved> <is_confirmed>true</is_confirmed> <location>sample string 13</location> <modified_dateutc>2026-09-16T11:02:33.331Z</modified_dateutc> <recurrence_id>4ddeef25-f8d0-4253-ae75-6de0328fd836</recurrence_id> <sys_logical_delete>true</sys_logical_delete> <time_span>sample string 17</time_span> <user_id>bcc3dd15-ae4d-4b15-8118-3bb8d444dd4b</user_id> <user_unavailability_type_id>0349da47-e339-400d-827e-e9fafda5aa53</user_unavailability_type_id> <user_unavailability_type_name>sample string 5</user_unavailability_type_name> <user_week_approval_id>358bf99a-45a2-4636-924e-153fda7372c9</user_week_approval_id> </user_unavailability>