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": "a0dd3729-0b8a-432c-984a-5c0744737a1f",
"Description": "sample string 2",
"Name": "sample string 3",
"EventType": "sample string 4",
"Owner": "sample string 5",
"StartDateTime": "2026-10-30T03:41:13.2793315+00:00",
"EndDateTime": "2026-10-30T03:41:13.2793315+00:00",
"RecurrencePattern": {
"RecurrenceType": 0,
"EndDateTime": "2026-10-30T03:41:13.2793315+00:00",
"StartDateTime": "2026-10-30T03:41:13.2793315+00:00",
"Interval": 3,
"UntilType": 0,
"UntilDate": "2026-10-30T03:41:13.2793315+00:00",
"NumberOfOccurrences": 5,
"RecurrenceDescription": "sample string 6",
"RecurrencePatternComplexDescription": "sample string 7"
},
"Occurrences": [
{
"Identity": "4b9330d3-4a63-45a2-b2aa-1ba88186199e",
"IsEdited": true,
"StartDateTime": "2026-10-30T03:41:13.2793315+00:00",
"EndDateTime": "2026-10-30T03:41:13.2793315+00:00"
},
{
"Identity": "4b9330d3-4a63-45a2-b2aa-1ba88186199e",
"IsEdited": true,
"StartDateTime": "2026-10-30T03:41:13.2793315+00:00",
"EndDateTime": "2026-10-30T03:41:13.2793315+00:00"
}
],
"BookingExecutions": [
{
"OccurrenceIdentity": "de657319-3d53-46f9-b5bc-0869c3df192b",
"StartInfo": {
"StartedDateTime": "2026-10-30T03:41:13.2793315+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-10-30T03:41:13.2793315+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
},
{
"OccurrenceIdentity": "de657319-3d53-46f9-b5bc-0869c3df192b",
"StartInfo": {
"StartedDateTime": "2026-10-30T03:41:13.2793315+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-10-30T03:41:13.2793315+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
}
],
"BookingTypeIdentity": "9612c9a6-d113-4682-824b-7f24a6a6c59a",
"FormIdentity": "6c0f49a2-ccb8-48e8-bb0f-78795140ae74",
"OccurrenceGroupIdentity": "893d8ec2-b64f-4298-a696-d195696891a1",
"Resources": [
{
"ResourceTypeIdentity": "68718ec1-61c2-4453-abc5-c3fa1631ac2f",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "63406850-a1f3-403a-9a0a-82dd3f076c6c",
"ResourceRestrictionIdentity": "ed0c2de0-0ecc-4faa-8e97-5e4a1d964fa3",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"9ca8cbf5-ddc1-46af-a06e-ef97d96adcdf",
"8aec998f-48e2-4436-8685-2a5ef4437f93"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"14a1993f-03bc-4f53-874b-2e5243174cce",
"8b34bbce-937f-4586-b2b3-4214c1c6314c"
],
"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": "ac937fbf-ea8f-4271-8151-5f73590f5194",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "68718ec1-61c2-4453-abc5-c3fa1631ac2f",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "63406850-a1f3-403a-9a0a-82dd3f076c6c",
"ResourceRestrictionIdentity": "ed0c2de0-0ecc-4faa-8e97-5e4a1d964fa3",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"9ca8cbf5-ddc1-46af-a06e-ef97d96adcdf",
"8aec998f-48e2-4436-8685-2a5ef4437f93"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"14a1993f-03bc-4f53-874b-2e5243174cce",
"8b34bbce-937f-4586-b2b3-4214c1c6314c"
],
"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": "ac937fbf-ea8f-4271-8151-5f73590f5194",
"Name": "sample string 10"
}
],
"CanEdit": true,
"CanCancel": true,
"CanEditEndDateTimeOnly": true,
"CanCopy": true,
"EventIdentity": "4ad88461-9363-4c0f-a692-ebf0b4e90fd3",
"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": "fd82a6a9-1aa7-4c2a-b4ee-b9ac3078625b",
"Name": "sample string 2",
"Sections": [
{
"Identity": "bd1be094-68ac-4f82-9e3b-e5dc6fcb90b3",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "52e605e6-944b-4407-96a4-df5f9bb6fa9e",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "52e605e6-944b-4407-96a4-df5f9bb6fa9e",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
}
]
},
{
"Identity": "bd1be094-68ac-4f82-9e3b-e5dc6fcb90b3",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "52e605e6-944b-4407-96a4-df5f9bb6fa9e",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "52e605e6-944b-4407-96a4-df5f9bb6fa9e",
"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": "e9fbe938-8b6a-4a15-9a9e-2fcd96c3fc83",
"Name": "sample string 2"
},
{
"Identity": "e9fbe938-8b6a-4a15-9a9e-2fcd96c3fc83",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
},
{
"MessageKey": "sample string 1",
"Message": "sample string 2",
"AffectedResources": [
{
"Identity": "e9fbe938-8b6a-4a15-9a9e-2fcd96c3fc83",
"Name": "sample string 2"
},
{
"Identity": "e9fbe938-8b6a-4a15-9a9e-2fcd96c3fc83",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
}
],
"RefittedResources": [
{
"ResourceTypeIdentity": "68718ec1-61c2-4453-abc5-c3fa1631ac2f",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "63406850-a1f3-403a-9a0a-82dd3f076c6c",
"ResourceRestrictionIdentity": "ed0c2de0-0ecc-4faa-8e97-5e4a1d964fa3",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"9ca8cbf5-ddc1-46af-a06e-ef97d96adcdf",
"8aec998f-48e2-4436-8685-2a5ef4437f93"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"14a1993f-03bc-4f53-874b-2e5243174cce",
"8b34bbce-937f-4586-b2b3-4214c1c6314c"
],
"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": "ac937fbf-ea8f-4271-8151-5f73590f5194",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "68718ec1-61c2-4453-abc5-c3fa1631ac2f",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "63406850-a1f3-403a-9a0a-82dd3f076c6c",
"ResourceRestrictionIdentity": "ed0c2de0-0ecc-4faa-8e97-5e4a1d964fa3",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"9ca8cbf5-ddc1-46af-a06e-ef97d96adcdf",
"8aec998f-48e2-4436-8685-2a5ef4437f93"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"14a1993f-03bc-4f53-874b-2e5243174cce",
"8b34bbce-937f-4586-b2b3-4214c1c6314c"
],
"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": "ac937fbf-ea8f-4271-8151-5f73590f5194",
"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": "e7358223-a3be-4a1b-87eb-94523545ea25"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.