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": "d663f83c-40cb-4550-b671-a4e3fe2c3a1f", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-09-04T15:06:49.0279541+00:00", "EndDateTime": "2025-09-04T15:06:49.0279541+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-09-04T15:06:49.0279541+00:00", "StartDateTime": "2025-09-04T15:06:49.0279541+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-09-04T15:06:49.0279541+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "62396549-09fc-4c80-b681-30c29dbf0d9c", "IsEdited": true, "StartDateTime": "2025-09-04T15:06:49.0279541+00:00", "EndDateTime": "2025-09-04T15:06:49.0279541+00:00" }, { "Identity": "62396549-09fc-4c80-b681-30c29dbf0d9c", "IsEdited": true, "StartDateTime": "2025-09-04T15:06:49.0279541+00:00", "EndDateTime": "2025-09-04T15:06:49.0279541+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "7d33b59f-3941-493e-b3c2-b25f03cc818d", "StartInfo": { "StartedDateTime": "2025-09-04T15:06:49.0279541+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-04T15:06:49.0279541+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "7d33b59f-3941-493e-b3c2-b25f03cc818d", "StartInfo": { "StartedDateTime": "2025-09-04T15:06:49.0279541+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-04T15:06:49.0279541+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "ad865cb4-6d2c-4444-9300-9ae8cd618281", "FormIdentity": "7ef13901-446f-4bd7-a8e2-c63f257bad16", "OccurrenceGroupIdentity": "590e4c70-fcf1-4d49-bb8b-48b4d515e975", "Resources": [ { "ResourceTypeIdentity": "f8234288-1bc1-4327-873b-4bfcce9c7323", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "2140e9fb-89e3-4d0c-8a3b-81cc3b1a3a0d", "ResourceRestrictionIdentity": "2abe4f43-4258-402b-8748-12b3f962c25e", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2058d69-0d16-4c24-a86a-58359263b024", "988de316-b9f3-4ce0-a407-612343198bfc" ], "BookingApprovers": { "PermissionGroupIdentities": [ "3ba5e2e7-5c6a-4ca7-96a1-00e6cc396ee2", "f8c84c2c-17a2-471c-954f-b07050441c33" ], "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": "f4c73905-742d-4967-a653-51d4548900dd", "Name": "sample string 10" }, { "ResourceTypeIdentity": "f8234288-1bc1-4327-873b-4bfcce9c7323", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "2140e9fb-89e3-4d0c-8a3b-81cc3b1a3a0d", "ResourceRestrictionIdentity": "2abe4f43-4258-402b-8748-12b3f962c25e", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2058d69-0d16-4c24-a86a-58359263b024", "988de316-b9f3-4ce0-a407-612343198bfc" ], "BookingApprovers": { "PermissionGroupIdentities": [ "3ba5e2e7-5c6a-4ca7-96a1-00e6cc396ee2", "f8c84c2c-17a2-471c-954f-b07050441c33" ], "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": "f4c73905-742d-4967-a653-51d4548900dd", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "d3841014-04b2-45cc-85fb-4d0498ec4539", "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": "22b7ea4d-6a39-4674-96ff-df73d2b5a156", "Name": "sample string 2", "Sections": [ { "Identity": "fdfa5088-6209-4734-863f-7ba41ff0724c", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "ee16339c-80bb-4e7e-a2b7-d277b56bacce", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "ee16339c-80bb-4e7e-a2b7-d277b56bacce", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "fdfa5088-6209-4734-863f-7ba41ff0724c", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "ee16339c-80bb-4e7e-a2b7-d277b56bacce", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "ee16339c-80bb-4e7e-a2b7-d277b56bacce", "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": "b28b0f8d-8959-43c7-babd-c13d99b0db8a", "Name": "sample string 2" }, { "Identity": "b28b0f8d-8959-43c7-babd-c13d99b0db8a", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "b28b0f8d-8959-43c7-babd-c13d99b0db8a", "Name": "sample string 2" }, { "Identity": "b28b0f8d-8959-43c7-babd-c13d99b0db8a", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "f8234288-1bc1-4327-873b-4bfcce9c7323", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "2140e9fb-89e3-4d0c-8a3b-81cc3b1a3a0d", "ResourceRestrictionIdentity": "2abe4f43-4258-402b-8748-12b3f962c25e", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2058d69-0d16-4c24-a86a-58359263b024", "988de316-b9f3-4ce0-a407-612343198bfc" ], "BookingApprovers": { "PermissionGroupIdentities": [ "3ba5e2e7-5c6a-4ca7-96a1-00e6cc396ee2", "f8c84c2c-17a2-471c-954f-b07050441c33" ], "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": "f4c73905-742d-4967-a653-51d4548900dd", "Name": "sample string 10" }, { "ResourceTypeIdentity": "f8234288-1bc1-4327-873b-4bfcce9c7323", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "2140e9fb-89e3-4d0c-8a3b-81cc3b1a3a0d", "ResourceRestrictionIdentity": "2abe4f43-4258-402b-8748-12b3f962c25e", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "a2058d69-0d16-4c24-a86a-58359263b024", "988de316-b9f3-4ce0-a407-612343198bfc" ], "BookingApprovers": { "PermissionGroupIdentities": [ "3ba5e2e7-5c6a-4ca7-96a1-00e6cc396ee2", "f8c84c2c-17a2-471c-954f-b07050441c33" ], "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": "f4c73905-742d-4967-a653-51d4548900dd", "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": "7926e045-1751-46ad-8ef3-52b34d81d07b" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.