POST api/travel/day/traveldate/{travelDateId}/lock
Creates a lock on a travel date for a specified duration. This prevents other users from modifying the travel date until the lock expires or is released.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| travelDateId |
The unique identifier of the travel date to lock. |
integer |
Required |
Body Parameters
The duration for which the lock should remain active. Sent in the request body as a TimeSpan (e.g., "01:30:00" for 1 hour 30 minutes).
time intervalRequest Formats
application/json, text/json, application/javascript
Sample:
"00:00:00.1234567"
application/xml, text/xml
Sample:
<TimeSpan xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Returns HTTP 201 (Created) with the created lock information
TravelDateLock| Name | Description | Type | Additional information |
|---|---|---|---|
| LockID | integer |
None. |
|
| TravelDateID | integer |
None. |
|
| PersonID | integer |
None. |
|
| Expires | date |
None. |
|
| LastName | string |
None. |
|
| FirstName | string |
None. |
|
| NickName | string |
None. |
|
| MaidenName | string |
None. |
|
| MiddleName | string |
None. |
|
| FullName | string |
None. |
|
| FullNameIncludeNickName | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"LastName": "sample string 5",
"FirstName": "sample string 6",
"NickName": "sample string 7",
"MaidenName": "sample string 8",
"MiddleName": "sample string 9",
"FullName": "sample string 6 sample string 5"
}
application/javascript
Sample:
{"LastName":"sample string 5","FirstName":"sample string 6","NickName":"sample string 7","MaidenName":"sample string 8","MiddleName":"sample string 9","FullName":"sample string 6 sample string 5"}
application/xml, text/xml
Sample:
<TravelDateLock xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <LastName>sample string 5</LastName> <FirstName>sample string 6</FirstName> <NickName>sample string 7</NickName> <MaidenName>sample string 8</MaidenName> <MiddleName>sample string 9</MiddleName> <FullName>sample string 6 sample string 5</FullName> <LockID>1</LockID> <TravelDateID>2</TravelDateID> <PersonID>3</PersonID> <Expires>2026-09-08T15:29:07.981376-06:00</Expires> </TravelDateLock>