Retrieves the unavailability type 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_type
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
code

Field used for Embedded entity (store there your ERP PK)

 string

Max length: 50
name

Name of the unavailability type

 string

Required

Max length: 20
description

Long description

 string

Max length: 100
default_travel_location

Default travel location

 string
is_holiday

is_holiday

 boolean
require_approval

require_approval

 boolean
archived

archived

 boolean
background_color

background color

 string
is_legal_holiday

is legal holiday?

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "a142a717-384d-4ce1-8fe9-48285e6622db",
  "code": "sample string 2",
  "name": "sample string 3",
  "description": "sample string 4",
  "default_travel_location": "sample string 5",
  "is_holiday": true,
  "require_approval": true,
  "archived": true,
  "background_color": "sample string 9",
  "is_legal_holiday": true,
  "modified_dateutc": "2026-01-11T21:01:58.6280692+00:00"
}

application/xml, text/xml

Sample: 
<user_unavailability_type xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <archived>true</archived>
  <background_color>sample string 9</background_color>
  <code>sample string 2</code>
  <default_travel_location>sample string 5</default_travel_location>
  <description>sample string 4</description>
  <id>a142a717-384d-4ce1-8fe9-48285e6622db</id>
  <is_holiday>true</is_holiday>
  <is_legal_holiday>true</is_legal_holiday>
  <modified_dateutc>2026-01-11T21:01:58.628Z</modified_dateutc>
  <name>sample string 3</name>
  <require_approval>true</require_approval>
</user_unavailability_type>