Creates or updates a user unavailability period.

Request Information

URI Parameters :

None.

Body Parameters :

user_unavailability
NameDescriptionTypeAdditional 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

Request Formats :

application/json, text/json

Sample: 
{
  "id": "1b1165bf-0c58-4b2c-8e6e-51b87c8c889a",
  "date_start": "2026-11-12T14:27:21.7745141+00:00",
  "date_end": "2026-11-12T14:27:21.7745141+00:00",
  "user_unavailability_type_id": "475d1884-f76c-4fa2-840c-806f4b2f46b3",
  "user_unavailability_type_name": "sample string 5",
  "description": "sample string 6",
  "sys_logical_delete": true,
  "user_id": "af59eb2f-1683-4919-a037-0e200b63a332",
  "modified_dateutc": "2026-11-12T14:27:21.7745141+00:00",
  "is_approved": true,
  "user_week_approval_id": "2ff6aa88-4345-488b-bb80-1042e9109df5",
  "db_address_id": "a3ab2b20-71f5-4c45-9cff-7be05eb4572e",
  "location": "sample string 13",
  "holiday_id": "0ea3c045-ec16-4f9c-aeb9-44b496644536",
  "archive_reason": "sample string 15",
  "recurrence_id": "29635c7c-d135-40f9-9e84-899c5d3f7595",
  "time_span": "sample string 17",
  "dateutc_create": "2026-11-12T14:27:21.7745141+00:00",
  "is_confirmed": true
}

application/xml, text/xml

Sample: 
<user_unavailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <archive_reason>sample string 15</archive_reason>
  <date_end>2026-11-12T14:27:21.774Z</date_end>
  <date_start>2026-11-12T14:27:21.774Z</date_start>
  <dateutc_create>2026-11-12T14:27:21.774Z</dateutc_create>
  <db_address_id>a3ab2b20-71f5-4c45-9cff-7be05eb4572e</db_address_id>
  <description>sample string 6</description>
  <holiday_id>0ea3c045-ec16-4f9c-aeb9-44b496644536</holiday_id>
  <id>1b1165bf-0c58-4b2c-8e6e-51b87c8c889a</id>
  <is_approved>true</is_approved>
  <is_confirmed>true</is_confirmed>
  <location>sample string 13</location>
  <modified_dateutc>2026-11-12T14:27:21.774Z</modified_dateutc>
  <recurrence_id>29635c7c-d135-40f9-9e84-899c5d3f7595</recurrence_id>
  <sys_logical_delete>true</sys_logical_delete>
  <time_span>sample string 17</time_span>
  <user_id>af59eb2f-1683-4919-a037-0e200b63a332</user_id>
  <user_unavailability_type_id>475d1884-f76c-4fa2-840c-806f4b2f46b3</user_unavailability_type_id>
  <user_unavailability_type_name>sample string 5</user_unavailability_type_name>
  <user_week_approval_id>2ff6aa88-4345-488b-bb80-1042e9109df5</user_week_approval_id>
</user_unavailability>

Response Information

Resource Description :

IHttpActionResult containing the saved user unavailability period.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.