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": "9f6b9015-dc86-4791-982d-76f477d3e9f4",
  "date_start": "2026-09-16T09:22:28.8713814+00:00",
  "date_end": "2026-09-16T09:22:28.8713814+00:00",
  "user_unavailability_type_id": "69c35f23-9955-41d9-84db-085ed5141e66",
  "user_unavailability_type_name": "sample string 5",
  "description": "sample string 6",
  "sys_logical_delete": true,
  "user_id": "20be6203-1036-4305-842a-e3da198d36a5",
  "modified_dateutc": "2026-09-16T09:22:28.8713814+00:00",
  "is_approved": true,
  "user_week_approval_id": "daa1f7f3-3498-41f1-b436-46034b91dd47",
  "db_address_id": "f1190ccc-81b7-424a-9c23-c677bf7b2678",
  "location": "sample string 13",
  "holiday_id": "2c23339c-cdb7-42be-838e-2fd020255d70",
  "archive_reason": "sample string 15",
  "recurrence_id": "fdca0bcc-3698-4b17-9b11-6209e63ee5a2",
  "time_span": "sample string 17",
  "dateutc_create": "2026-09-16T09:22:28.8713814+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-09-16T09:22:28.871Z</date_end>
  <date_start>2026-09-16T09:22:28.871Z</date_start>
  <dateutc_create>2026-09-16T09:22:28.871Z</dateutc_create>
  <db_address_id>f1190ccc-81b7-424a-9c23-c677bf7b2678</db_address_id>
  <description>sample string 6</description>
  <holiday_id>2c23339c-cdb7-42be-838e-2fd020255d70</holiday_id>
  <id>9f6b9015-dc86-4791-982d-76f477d3e9f4</id>
  <is_approved>true</is_approved>
  <is_confirmed>true</is_confirmed>
  <location>sample string 13</location>
  <modified_dateutc>2026-09-16T09:22:28.871Z</modified_dateutc>
  <recurrence_id>fdca0bcc-3698-4b17-9b11-6209e63ee5a2</recurrence_id>
  <sys_logical_delete>true</sys_logical_delete>
  <time_span>sample string 17</time_span>
  <user_id>20be6203-1036-4305-842a-e3da198d36a5</user_id>
  <user_unavailability_type_id>69c35f23-9955-41d9-84db-085ed5141e66</user_unavailability_type_id>
  <user_unavailability_type_name>sample string 5</user_unavailability_type_name>
  <user_week_approval_id>daa1f7f3-3498-41f1-b436-46034b91dd47</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.