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": "85b10131-34e3-4446-911d-8405d61cc7f8", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-09-14T10:25:29.2066476+00:00", "EndDateTime": "2025-09-14T10:25:29.2066476+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-09-14T10:25:29.2066476+00:00", "StartDateTime": "2025-09-14T10:25:29.2066476+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-09-14T10:25:29.2066476+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "d8f9c701-103f-452f-bfa2-0f72a18f3a43", "IsEdited": true, "StartDateTime": "2025-09-14T10:25:29.2066476+00:00", "EndDateTime": "2025-09-14T10:25:29.2066476+00:00" }, { "Identity": "d8f9c701-103f-452f-bfa2-0f72a18f3a43", "IsEdited": true, "StartDateTime": "2025-09-14T10:25:29.2066476+00:00", "EndDateTime": "2025-09-14T10:25:29.2066476+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "07d749bd-f3f2-4b92-bf09-18a4b683fb88", "StartInfo": { "StartedDateTime": "2025-09-14T10:25:29.2066476+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-14T10:25:29.2066476+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "07d749bd-f3f2-4b92-bf09-18a4b683fb88", "StartInfo": { "StartedDateTime": "2025-09-14T10:25:29.2066476+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-14T10:25:29.2066476+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "0653c272-b41c-414b-a3e9-0a0cf244b514", "FormIdentity": "cebcdaa7-f694-40aa-a46e-a4bac6a0f6b1", "OccurrenceGroupIdentity": "d41568ed-62e2-4fcc-9ddd-4f15dc8ee619", "Resources": [ { "ResourceTypeIdentity": "36ef4e30-b51b-4da0-8925-4ca0a7f18c95", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "dd607e7d-fa94-4927-95ac-953f2c78dbc7", "ResourceRestrictionIdentity": "877bb4e4-a78b-4c17-88da-665977f9c002", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "e68e8630-6e05-49a6-873c-323616f54537", "68439240-bddd-4fab-a2fe-da54971efd16" ], "BookingApprovers": { "PermissionGroupIdentities": [ "0f2d63aa-3559-4361-b372-fcbcd80edaeb", "d0351223-dae1-41db-855b-d8dcf2e3ce88" ], "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": "f07b69cc-8f56-4469-b267-8420b6dc6fa2", "Name": "sample string 10" }, { "ResourceTypeIdentity": "36ef4e30-b51b-4da0-8925-4ca0a7f18c95", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "dd607e7d-fa94-4927-95ac-953f2c78dbc7", "ResourceRestrictionIdentity": "877bb4e4-a78b-4c17-88da-665977f9c002", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "e68e8630-6e05-49a6-873c-323616f54537", "68439240-bddd-4fab-a2fe-da54971efd16" ], "BookingApprovers": { "PermissionGroupIdentities": [ "0f2d63aa-3559-4361-b372-fcbcd80edaeb", "d0351223-dae1-41db-855b-d8dcf2e3ce88" ], "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": "f07b69cc-8f56-4469-b267-8420b6dc6fa2", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "7f8c19ef-6071-4f20-9bdb-9ca5f1674144", "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": "6889714f-f24f-4163-a61e-acde42cc6217", "Name": "sample string 2", "Sections": [ { "Identity": "4a5ce815-4ad9-4042-9f57-b09c320a8007", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "d0b14598-20b3-4eff-83c2-df5a74b01fee", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "d0b14598-20b3-4eff-83c2-df5a74b01fee", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "4a5ce815-4ad9-4042-9f57-b09c320a8007", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "d0b14598-20b3-4eff-83c2-df5a74b01fee", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "d0b14598-20b3-4eff-83c2-df5a74b01fee", "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": "512b3de6-4cd5-470b-b37c-d7a37eb1ca64", "Name": "sample string 2" }, { "Identity": "512b3de6-4cd5-470b-b37c-d7a37eb1ca64", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "512b3de6-4cd5-470b-b37c-d7a37eb1ca64", "Name": "sample string 2" }, { "Identity": "512b3de6-4cd5-470b-b37c-d7a37eb1ca64", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "36ef4e30-b51b-4da0-8925-4ca0a7f18c95", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "dd607e7d-fa94-4927-95ac-953f2c78dbc7", "ResourceRestrictionIdentity": "877bb4e4-a78b-4c17-88da-665977f9c002", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "e68e8630-6e05-49a6-873c-323616f54537", "68439240-bddd-4fab-a2fe-da54971efd16" ], "BookingApprovers": { "PermissionGroupIdentities": [ "0f2d63aa-3559-4361-b372-fcbcd80edaeb", "d0351223-dae1-41db-855b-d8dcf2e3ce88" ], "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": "f07b69cc-8f56-4469-b267-8420b6dc6fa2", "Name": "sample string 10" }, { "ResourceTypeIdentity": "36ef4e30-b51b-4da0-8925-4ca0a7f18c95", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "dd607e7d-fa94-4927-95ac-953f2c78dbc7", "ResourceRestrictionIdentity": "877bb4e4-a78b-4c17-88da-665977f9c002", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "e68e8630-6e05-49a6-873c-323616f54537", "68439240-bddd-4fab-a2fe-da54971efd16" ], "BookingApprovers": { "PermissionGroupIdentities": [ "0f2d63aa-3559-4361-b372-fcbcd80edaeb", "d0351223-dae1-41db-855b-d8dcf2e3ce88" ], "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": "f07b69cc-8f56-4469-b267-8420b6dc6fa2", "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": "957765e4-d3d2-48e7-9bd4-7bd5b1cd8b7f" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.