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
BookingRequestName | 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": "90a75849-dc83-48be-8342-eb1123a9ec60", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-09-07T05:16:00.0580439+00:00", "EndDateTime": "2025-09-07T05:16:00.0580439+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-09-07T05:16:00.0580439+00:00", "StartDateTime": "2025-09-07T05:16:00.0580439+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-09-07T05:16:00.0580439+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "bf2d94cc-1ff4-4377-96a2-2d4b2aa0b3a0", "IsEdited": true, "StartDateTime": "2025-09-07T05:16:00.0580439+00:00", "EndDateTime": "2025-09-07T05:16:00.0580439+00:00" }, { "Identity": "bf2d94cc-1ff4-4377-96a2-2d4b2aa0b3a0", "IsEdited": true, "StartDateTime": "2025-09-07T05:16:00.0580439+00:00", "EndDateTime": "2025-09-07T05:16:00.0580439+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "544470fb-ac62-45f1-ba59-c6bdf273756a", "StartInfo": { "StartedDateTime": "2025-09-07T05:16:00.0580439+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-07T05:16:00.0580439+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "544470fb-ac62-45f1-ba59-c6bdf273756a", "StartInfo": { "StartedDateTime": "2025-09-07T05:16:00.0580439+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-07T05:16:00.0580439+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "f25fb1c0-7346-4986-a3e2-23d540f34c51", "FormIdentity": "588dd9c0-e1a8-47cd-ad01-c5fe7765879d", "OccurrenceGroupIdentity": "099ec8e2-d46b-480c-a3f8-bb4ee01bc4cf", "Resources": [ { "ResourceTypeIdentity": "6a2893c0-b7ef-41ca-8abe-51c1f33988f5", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "6f869efb-8297-438e-8919-116b25a4142c", "ResourceRestrictionIdentity": "eefee8a5-0fea-46f7-8cf7-ae95473ceb2d", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2d45bca-aea8-41b8-b5aa-5eb941f89776", "55a70c9f-fdaa-4e78-8cd9-f694ab7c6858" ], "BookingApprovers": { "PermissionGroupIdentities": [ "20a25b89-19d7-4908-b6e0-be46879e2da7", "4e585e6b-7cda-46a1-812e-60d5c598d8e2" ], "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": "9f45cc75-216c-4e6a-9c92-d6a5e32d54e2", "Name": "sample string 10" }, { "ResourceTypeIdentity": "6a2893c0-b7ef-41ca-8abe-51c1f33988f5", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "6f869efb-8297-438e-8919-116b25a4142c", "ResourceRestrictionIdentity": "eefee8a5-0fea-46f7-8cf7-ae95473ceb2d", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2d45bca-aea8-41b8-b5aa-5eb941f89776", "55a70c9f-fdaa-4e78-8cd9-f694ab7c6858" ], "BookingApprovers": { "PermissionGroupIdentities": [ "20a25b89-19d7-4908-b6e0-be46879e2da7", "4e585e6b-7cda-46a1-812e-60d5c598d8e2" ], "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": "9f45cc75-216c-4e6a-9c92-d6a5e32d54e2", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "d734e59f-cf66-47f7-957d-7c943f95cb4f", "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": "8170cee9-0994-4cdc-8d67-d95dff6bdd08", "Name": "sample string 2", "Sections": [ { "Identity": "c22bb464-8620-4934-a334-d178ce110595", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "270b1b4e-b536-460b-9059-fddb25838aa5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "270b1b4e-b536-460b-9059-fddb25838aa5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "c22bb464-8620-4934-a334-d178ce110595", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "270b1b4e-b536-460b-9059-fddb25838aa5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "270b1b4e-b536-460b-9059-fddb25838aa5", "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": "c966563b-7bf8-45d1-88ce-72b9911a89a5", "Name": "sample string 2" }, { "Identity": "c966563b-7bf8-45d1-88ce-72b9911a89a5", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "c966563b-7bf8-45d1-88ce-72b9911a89a5", "Name": "sample string 2" }, { "Identity": "c966563b-7bf8-45d1-88ce-72b9911a89a5", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "6a2893c0-b7ef-41ca-8abe-51c1f33988f5", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "6f869efb-8297-438e-8919-116b25a4142c", "ResourceRestrictionIdentity": "eefee8a5-0fea-46f7-8cf7-ae95473ceb2d", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2d45bca-aea8-41b8-b5aa-5eb941f89776", "55a70c9f-fdaa-4e78-8cd9-f694ab7c6858" ], "BookingApprovers": { "PermissionGroupIdentities": [ "20a25b89-19d7-4908-b6e0-be46879e2da7", "4e585e6b-7cda-46a1-812e-60d5c598d8e2" ], "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": "9f45cc75-216c-4e6a-9c92-d6a5e32d54e2", "Name": "sample string 10" }, { "ResourceTypeIdentity": "6a2893c0-b7ef-41ca-8abe-51c1f33988f5", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "6f869efb-8297-438e-8919-116b25a4142c", "ResourceRestrictionIdentity": "eefee8a5-0fea-46f7-8cf7-ae95473ceb2d", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2d45bca-aea8-41b8-b5aa-5eb941f89776", "55a70c9f-fdaa-4e78-8cd9-f694ab7c6858" ], "BookingApprovers": { "PermissionGroupIdentities": [ "20a25b89-19d7-4908-b6e0-be46879e2da7", "4e585e6b-7cda-46a1-812e-60d5c598d8e2" ], "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": "9f45cc75-216c-4e6a-9c92-d6a5e32d54e2", "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": "9d188769-41a1-4776-a23e-8694ba47fbf7" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.