GET api/BookingRequests/{id}?checkResourceRestrictions={checkResourceRestrictions}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| checkResourceRestrictions | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
BookingRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Identity | globally unique identifier |
None. |
|
| Description | string |
None. |
|
| Name | string |
None. |
|
| EventType | string |
None. |
|
| Owner | string |
None. |
|
| StartDateTime | date |
None. |
|
| EndDateTime | date |
None. |
|
| RecurrencePattern | RecurrencePatternObject |
None. |
|
| Occurrences | Collection of Occurrence |
None. |
|
| BookingExecutions | Collection of BookingExecution |
None. |
|
| BookingTypeIdentity | globally unique identifier |
None. |
|
| FormIdentity | globally unique identifier |
None. |
|
| OccurrenceGroupIdentity | globally unique identifier |
None. |
|
| Resources | Collection of BookingResource |
None. |
|
| CanEdit | boolean |
None. |
|
| CanCancel | boolean |
None. |
|
| CanEditEndDateTimeOnly | boolean |
None. |
|
| CanCopy | boolean |
None. |
|
| EventIdentity | globally unique identifier |
None. |
|
| BookerName | string |
None. |
|
| BookerEmailAddress | string |
None. |
|
| AdditionalEmailAddresses | Collection of string |
None. |
|
| Status | string |
None. |
|
| HasRecurrence | boolean |
None. |
|
| IsEdited | boolean |
None. |
|
| Reference | string |
None. |
|
| BookingRequestFormValue | BookingRequestFormValue |
None. |
|
| HistoryCount | integer |
None. |
|
| RevisedBy | string |
None. |
|
| RevisedByEmailAddress | string |
None. |
|
| SkipUpdateOccurrencePattern | boolean |
None. |
|
| IsCurrentlyActive | boolean |
None. |
|
| EditRestrictions | Collection of BookingRequestEditRestriction |
None. |
|
| RefittedResources | Collection of BookingResource |
None. |
|
| IsImport | boolean |
None. |
|
| ImportedBy | string |
None. |
|
| ImportedByEmailAddress | string |
None. |
|
| Source | string |
None. |
|
| PrimaryResourceChanged | boolean |
None. |
|
| PrimaryResourceChangedByEmailAddress | string |
None. |
|
| CopiedFromIdentity | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"Identity": "c7b39d80-174f-44c6-94d1-4dea7361c472",
"Description": "sample string 2",
"Name": "sample string 3",
"EventType": "sample string 4",
"Owner": "sample string 5",
"StartDateTime": "2025-11-02T04:34:17.6605024+00:00",
"EndDateTime": "2025-11-02T04:34:17.6605024+00:00",
"RecurrencePattern": {
"RecurrenceType": 0,
"EndDateTime": "2025-11-02T04:34:17.6605024+00:00",
"StartDateTime": "2025-11-02T04:34:17.6605024+00:00",
"Interval": 3,
"UntilType": 0,
"UntilDate": "2025-11-02T04:34:17.6605024+00:00",
"NumberOfOccurrences": 5,
"RecurrenceDescription": "sample string 6",
"RecurrencePatternComplexDescription": "sample string 7"
},
"Occurrences": [
{
"Identity": "ac139b1c-ccf4-4cfe-a588-f3cbe7dec731",
"IsEdited": true,
"StartDateTime": "2025-11-02T04:34:17.6605024+00:00",
"EndDateTime": "2025-11-02T04:34:17.6605024+00:00"
},
{
"Identity": "ac139b1c-ccf4-4cfe-a588-f3cbe7dec731",
"IsEdited": true,
"StartDateTime": "2025-11-02T04:34:17.6605024+00:00",
"EndDateTime": "2025-11-02T04:34:17.6605024+00:00"
}
],
"BookingExecutions": [
{
"OccurrenceIdentity": "899a05ef-acfb-4e24-a767-cad670f6136f",
"StartInfo": {
"StartedDateTime": "2025-11-02T04:34:17.6605024+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2025-11-02T04:34:17.6605024+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
},
{
"OccurrenceIdentity": "899a05ef-acfb-4e24-a767-cad670f6136f",
"StartInfo": {
"StartedDateTime": "2025-11-02T04:34:17.6605024+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2025-11-02T04:34:17.6605024+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
}
],
"BookingTypeIdentity": "28eadcb8-11f7-491b-9e38-9dcb33e63ec5",
"FormIdentity": "4699d5af-9ee8-4ba9-bfeb-81ebe1885958",
"OccurrenceGroupIdentity": "9f91a3bb-2fd0-4f2e-9698-a0cfe5508b99",
"Resources": [
{
"ResourceTypeIdentity": "8ad5a4b9-bfcf-4d31-8bc2-4e9fbe3e299e",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "08ded308-0998-41c4-835e-0fffd7aea5a0",
"ResourceRestrictionIdentity": "e6c432c9-34e8-4835-8688-296453b3715e",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"1a27cf71-bcc0-46c7-8503-97237d346a05",
"43d5857b-bd79-4644-8ab6-9cba5230c36a"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"3751d000-5746-4808-bbde-66faac161d00",
"1534dad4-95c2-4392-bfb7-bff8ca833162"
],
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
]
},
"CanViewCalendar": true,
"Identity": "3202a9ff-1409-4d88-a1ab-f43c1d60d23f",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "8ad5a4b9-bfcf-4d31-8bc2-4e9fbe3e299e",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "08ded308-0998-41c4-835e-0fffd7aea5a0",
"ResourceRestrictionIdentity": "e6c432c9-34e8-4835-8688-296453b3715e",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"1a27cf71-bcc0-46c7-8503-97237d346a05",
"43d5857b-bd79-4644-8ab6-9cba5230c36a"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"3751d000-5746-4808-bbde-66faac161d00",
"1534dad4-95c2-4392-bfb7-bff8ca833162"
],
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
]
},
"CanViewCalendar": true,
"Identity": "3202a9ff-1409-4d88-a1ab-f43c1d60d23f",
"Name": "sample string 10"
}
],
"CanEdit": true,
"CanCancel": true,
"CanEditEndDateTimeOnly": true,
"CanCopy": true,
"EventIdentity": "fb165408-13b5-4ef0-ad75-1be0144ce4da",
"BookerName": "sample string 16",
"BookerEmailAddress": "sample string 17",
"AdditionalEmailAddresses": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 18",
"HasRecurrence": true,
"IsEdited": true,
"Reference": "sample string 20",
"BookingRequestFormValue": {
"Identity": "8b0f63cd-4df8-45d6-964a-3bdf70b33219",
"Name": "sample string 2",
"Sections": [
{
"Identity": "cd5c6a30-c80b-46aa-bf9e-d3687e71f5c8",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "dc65fb61-36af-4dba-a0b8-b09708ec7c3c",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "dc65fb61-36af-4dba-a0b8-b09708ec7c3c",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
}
]
},
{
"Identity": "cd5c6a30-c80b-46aa-bf9e-d3687e71f5c8",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "dc65fb61-36af-4dba-a0b8-b09708ec7c3c",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "dc65fb61-36af-4dba-a0b8-b09708ec7c3c",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
}
]
}
]
},
"HistoryCount": 21,
"RevisedBy": "sample string 22",
"RevisedByEmailAddress": "sample string 23",
"SkipUpdateOccurrencePattern": true,
"IsCurrentlyActive": true,
"EditRestrictions": [
{
"MessageKey": "sample string 1",
"Message": "sample string 2",
"AffectedResources": [
{
"Identity": "61e8943f-18aa-406f-8f3d-27b9a2a9f9c2",
"Name": "sample string 2"
},
{
"Identity": "61e8943f-18aa-406f-8f3d-27b9a2a9f9c2",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
},
{
"MessageKey": "sample string 1",
"Message": "sample string 2",
"AffectedResources": [
{
"Identity": "61e8943f-18aa-406f-8f3d-27b9a2a9f9c2",
"Name": "sample string 2"
},
{
"Identity": "61e8943f-18aa-406f-8f3d-27b9a2a9f9c2",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
}
],
"RefittedResources": [
{
"ResourceTypeIdentity": "8ad5a4b9-bfcf-4d31-8bc2-4e9fbe3e299e",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "08ded308-0998-41c4-835e-0fffd7aea5a0",
"ResourceRestrictionIdentity": "e6c432c9-34e8-4835-8688-296453b3715e",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"1a27cf71-bcc0-46c7-8503-97237d346a05",
"43d5857b-bd79-4644-8ab6-9cba5230c36a"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"3751d000-5746-4808-bbde-66faac161d00",
"1534dad4-95c2-4392-bfb7-bff8ca833162"
],
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
]
},
"CanViewCalendar": true,
"Identity": "3202a9ff-1409-4d88-a1ab-f43c1d60d23f",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "8ad5a4b9-bfcf-4d31-8bc2-4e9fbe3e299e",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "08ded308-0998-41c4-835e-0fffd7aea5a0",
"ResourceRestrictionIdentity": "e6c432c9-34e8-4835-8688-296453b3715e",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"1a27cf71-bcc0-46c7-8503-97237d346a05",
"43d5857b-bd79-4644-8ab6-9cba5230c36a"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"3751d000-5746-4808-bbde-66faac161d00",
"1534dad4-95c2-4392-bfb7-bff8ca833162"
],
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
]
},
"CanViewCalendar": true,
"Identity": "3202a9ff-1409-4d88-a1ab-f43c1d60d23f",
"Name": "sample string 10"
}
],
"IsImport": true,
"ImportedBy": "sample string 27",
"ImportedByEmailAddress": "sample string 28",
"Source": "sample string 29",
"PrimaryResourceChanged": true,
"PrimaryResourceChangedByEmailAddress": "sample string 31",
"CopiedFromIdentity": "7de016fb-a107-467f-9599-06216b71fbb0"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.