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": "0cc32edd-2f0f-4fbb-9846-6a517aad97d0",
"Description": "sample string 2",
"Name": "sample string 3",
"EventType": "sample string 4",
"Owner": "sample string 5",
"StartDateTime": "2026-05-02T13:33:40.1605688+00:00",
"EndDateTime": "2026-05-02T13:33:40.1605688+00:00",
"RecurrencePattern": {
"RecurrenceType": 0,
"EndDateTime": "2026-05-02T13:33:40.1605688+00:00",
"StartDateTime": "2026-05-02T13:33:40.1605688+00:00",
"Interval": 3,
"UntilType": 0,
"UntilDate": "2026-05-02T13:33:40.1605688+00:00",
"NumberOfOccurrences": 5,
"RecurrenceDescription": "sample string 6",
"RecurrencePatternComplexDescription": "sample string 7"
},
"Occurrences": [
{
"Identity": "8c06b4ba-f3bc-4f3b-8998-bea0e0a10fe0",
"IsEdited": true,
"StartDateTime": "2026-05-02T13:33:40.1605688+00:00",
"EndDateTime": "2026-05-02T13:33:40.1605688+00:00"
},
{
"Identity": "8c06b4ba-f3bc-4f3b-8998-bea0e0a10fe0",
"IsEdited": true,
"StartDateTime": "2026-05-02T13:33:40.1605688+00:00",
"EndDateTime": "2026-05-02T13:33:40.1605688+00:00"
}
],
"BookingExecutions": [
{
"OccurrenceIdentity": "362eb0d8-b506-477e-bc88-30790d7a629d",
"StartInfo": {
"StartedDateTime": "2026-05-02T13:33:40.1605688+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-05-02T13:33:40.1605688+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
},
{
"OccurrenceIdentity": "362eb0d8-b506-477e-bc88-30790d7a629d",
"StartInfo": {
"StartedDateTime": "2026-05-02T13:33:40.1605688+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-05-02T13:33:40.1605688+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
}
],
"BookingTypeIdentity": "a3b890a7-8f2c-491b-8e20-57d9a8261224",
"FormIdentity": "dd9bbbc1-b943-4aab-ae20-817e86cb1eaa",
"OccurrenceGroupIdentity": "443d6a4c-cf9a-49e6-884c-243a2de46ba9",
"Resources": [
{
"ResourceTypeIdentity": "e646ea8a-be41-44fd-b892-447097a4f7d1",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "756dfd0a-a95e-46ff-bbf4-e8dfa7f146e9",
"ResourceRestrictionIdentity": "8f8a5371-08cf-4401-a520-44f39b5f9e9b",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"2f6c768e-e2d4-4a46-b3e8-09a1b5854e55",
"1aa96c7f-29e0-49be-a132-59e8132f5f14"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"a2e1ab73-05d2-4699-b8b5-6d5db69420d2",
"31d12237-dae4-49b3-a609-4d59142b5e82"
],
"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": "9f82caa6-ebeb-401d-88ff-9ead4b4805ae",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "e646ea8a-be41-44fd-b892-447097a4f7d1",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "756dfd0a-a95e-46ff-bbf4-e8dfa7f146e9",
"ResourceRestrictionIdentity": "8f8a5371-08cf-4401-a520-44f39b5f9e9b",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"2f6c768e-e2d4-4a46-b3e8-09a1b5854e55",
"1aa96c7f-29e0-49be-a132-59e8132f5f14"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"a2e1ab73-05d2-4699-b8b5-6d5db69420d2",
"31d12237-dae4-49b3-a609-4d59142b5e82"
],
"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": "9f82caa6-ebeb-401d-88ff-9ead4b4805ae",
"Name": "sample string 10"
}
],
"CanEdit": true,
"CanCancel": true,
"CanEditEndDateTimeOnly": true,
"CanCopy": true,
"EventIdentity": "ba2db946-99fa-4241-8078-be756e1c382b",
"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": "f89ebdc5-421a-4e17-9941-26356cefa06f",
"Name": "sample string 2",
"Sections": [
{
"Identity": "cb40ce20-0040-4916-a752-283562682671",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "5c85956f-9044-450e-b822-11249fa7522a",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "5c85956f-9044-450e-b822-11249fa7522a",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
}
]
},
{
"Identity": "cb40ce20-0040-4916-a752-283562682671",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "5c85956f-9044-450e-b822-11249fa7522a",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "5c85956f-9044-450e-b822-11249fa7522a",
"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": "6cee2d41-9e19-4122-8b0c-82ace6ddae3c",
"Name": "sample string 2"
},
{
"Identity": "6cee2d41-9e19-4122-8b0c-82ace6ddae3c",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
},
{
"MessageKey": "sample string 1",
"Message": "sample string 2",
"AffectedResources": [
{
"Identity": "6cee2d41-9e19-4122-8b0c-82ace6ddae3c",
"Name": "sample string 2"
},
{
"Identity": "6cee2d41-9e19-4122-8b0c-82ace6ddae3c",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
}
],
"RefittedResources": [
{
"ResourceTypeIdentity": "e646ea8a-be41-44fd-b892-447097a4f7d1",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "756dfd0a-a95e-46ff-bbf4-e8dfa7f146e9",
"ResourceRestrictionIdentity": "8f8a5371-08cf-4401-a520-44f39b5f9e9b",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"2f6c768e-e2d4-4a46-b3e8-09a1b5854e55",
"1aa96c7f-29e0-49be-a132-59e8132f5f14"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"a2e1ab73-05d2-4699-b8b5-6d5db69420d2",
"31d12237-dae4-49b3-a609-4d59142b5e82"
],
"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": "9f82caa6-ebeb-401d-88ff-9ead4b4805ae",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "e646ea8a-be41-44fd-b892-447097a4f7d1",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "756dfd0a-a95e-46ff-bbf4-e8dfa7f146e9",
"ResourceRestrictionIdentity": "8f8a5371-08cf-4401-a520-44f39b5f9e9b",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"2f6c768e-e2d4-4a46-b3e8-09a1b5854e55",
"1aa96c7f-29e0-49be-a132-59e8132f5f14"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"a2e1ab73-05d2-4699-b8b5-6d5db69420d2",
"31d12237-dae4-49b3-a609-4d59142b5e82"
],
"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": "9f82caa6-ebeb-401d-88ff-9ead4b4805ae",
"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": "7d5a559e-c878-4041-ac97-3cc028f9583c"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.