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": "ff17a832-bdf1-4cb7-91f5-a2d04def439b",
"date_start": "2026-11-12T14:27:53.3687781+00:00",
"date_end": "2026-11-12T14:27:53.3687781+00:00",
"user_unavailability_type_id": "0f8be60a-0444-47c2-8aa8-6cb860d5317c",
"user_unavailability_type_name": "sample string 5",
"description": "sample string 6",
"sys_logical_delete": true,
"user_id": "6fbf3de9-a1ee-43da-a363-2c022a603f57",
"modified_dateutc": "2026-11-12T14:27:53.3687781+00:00",
"is_approved": true,
"user_week_approval_id": "737e07c1-cf7e-4350-8e35-ad1247ae653b",
"db_address_id": "d844bc21-b117-4217-8d5b-8447205fb902",
"location": "sample string 13",
"holiday_id": "834ac853-522a-479f-8225-ec28a770638f",
"archive_reason": "sample string 15",
"recurrence_id": "c3a407b2-f893-4297-a47c-bdff90b666f6",
"time_span": "sample string 17",
"dateutc_create": "2026-11-12T14:27:53.3687781+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-11-12T14:27:53.368Z</date_end> <date_start>2026-11-12T14:27:53.368Z</date_start> <dateutc_create>2026-11-12T14:27:53.368Z</dateutc_create> <db_address_id>d844bc21-b117-4217-8d5b-8447205fb902</db_address_id> <description>sample string 6</description> <holiday_id>834ac853-522a-479f-8225-ec28a770638f</holiday_id> <id>ff17a832-bdf1-4cb7-91f5-a2d04def439b</id> <is_approved>true</is_approved> <is_confirmed>true</is_confirmed> <location>sample string 13</location> <modified_dateutc>2026-11-12T14:27:53.368Z</modified_dateutc> <recurrence_id>c3a407b2-f893-4297-a47c-bdff90b666f6</recurrence_id> <sys_logical_delete>true</sys_logical_delete> <time_span>sample string 17</time_span> <user_id>6fbf3de9-a1ee-43da-a363-2c022a603f57</user_id> <user_unavailability_type_id>0f8be60a-0444-47c2-8aa8-6cb860d5317c</user_unavailability_type_id> <user_unavailability_type_name>sample string 5</user_unavailability_type_name> <user_week_approval_id>737e07c1-cf7e-4350-8e35-ad1247ae653b</user_week_approval_id> </user_unavailability>