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": "675fc167-2caa-461c-91a5-9ac28b91d5c9", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-09-05T18:58:19.5211878+00:00", "EndDateTime": "2025-09-05T18:58:19.5211878+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-09-05T18:58:19.5211878+00:00", "StartDateTime": "2025-09-05T18:58:19.5211878+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-09-05T18:58:19.5211878+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "84dfcc55-73b0-4798-bfee-4eb8786ba232", "IsEdited": true, "StartDateTime": "2025-09-05T18:58:19.5211878+00:00", "EndDateTime": "2025-09-05T18:58:19.5211878+00:00" }, { "Identity": "84dfcc55-73b0-4798-bfee-4eb8786ba232", "IsEdited": true, "StartDateTime": "2025-09-05T18:58:19.5211878+00:00", "EndDateTime": "2025-09-05T18:58:19.5211878+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "18ce919b-89fe-4d1c-8d5a-de715c684684", "StartInfo": { "StartedDateTime": "2025-09-05T18:58:19.5211878+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-05T18:58:19.5211878+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "18ce919b-89fe-4d1c-8d5a-de715c684684", "StartInfo": { "StartedDateTime": "2025-09-05T18:58:19.5211878+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-05T18:58:19.5211878+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "1f32e685-1e2d-402d-a366-355d6b936168", "FormIdentity": "b7218278-3a72-49e7-832c-4e9f9ed5b801", "OccurrenceGroupIdentity": "188fb140-4a8d-4bdc-8131-788adb7a80cb", "Resources": [ { "ResourceTypeIdentity": "98fbb467-43d9-435c-8760-9a080b8556a4", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "323e6341-e821-4bb6-a41a-806f02a7c91f", "ResourceRestrictionIdentity": "98009ea0-067e-4750-972d-2501907def31", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "91023d20-5dfa-46e1-97fe-deb90a101682", "197bca2f-b2fc-4b7b-bfe7-840e0fe92c9a" ], "BookingApprovers": { "PermissionGroupIdentities": [ "ceed5db3-dbcb-4a5a-863f-fa134f3e1444", "31213f49-c986-4ec3-afe1-80376bc8cdad" ], "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": "b9be7b99-c04a-444b-b7e2-e2138885c4fe", "Name": "sample string 10" }, { "ResourceTypeIdentity": "98fbb467-43d9-435c-8760-9a080b8556a4", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "323e6341-e821-4bb6-a41a-806f02a7c91f", "ResourceRestrictionIdentity": "98009ea0-067e-4750-972d-2501907def31", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "91023d20-5dfa-46e1-97fe-deb90a101682", "197bca2f-b2fc-4b7b-bfe7-840e0fe92c9a" ], "BookingApprovers": { "PermissionGroupIdentities": [ "ceed5db3-dbcb-4a5a-863f-fa134f3e1444", "31213f49-c986-4ec3-afe1-80376bc8cdad" ], "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": "b9be7b99-c04a-444b-b7e2-e2138885c4fe", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "4aced2cd-5194-4b3f-a758-c094f1e11550", "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": "4ed35a68-1379-4956-8460-260d0a7331a4", "Name": "sample string 2", "Sections": [ { "Identity": "d25e2bd8-6f39-4e6f-ac60-09749e3977f3", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "4399f21c-9f44-4f49-a37d-9be2c2b1c993", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "4399f21c-9f44-4f49-a37d-9be2c2b1c993", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "d25e2bd8-6f39-4e6f-ac60-09749e3977f3", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "4399f21c-9f44-4f49-a37d-9be2c2b1c993", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "4399f21c-9f44-4f49-a37d-9be2c2b1c993", "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": "95130900-6362-4a02-bab1-d760adb90c7f", "Name": "sample string 2" }, { "Identity": "95130900-6362-4a02-bab1-d760adb90c7f", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "95130900-6362-4a02-bab1-d760adb90c7f", "Name": "sample string 2" }, { "Identity": "95130900-6362-4a02-bab1-d760adb90c7f", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "98fbb467-43d9-435c-8760-9a080b8556a4", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "323e6341-e821-4bb6-a41a-806f02a7c91f", "ResourceRestrictionIdentity": "98009ea0-067e-4750-972d-2501907def31", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "91023d20-5dfa-46e1-97fe-deb90a101682", "197bca2f-b2fc-4b7b-bfe7-840e0fe92c9a" ], "BookingApprovers": { "PermissionGroupIdentities": [ "ceed5db3-dbcb-4a5a-863f-fa134f3e1444", "31213f49-c986-4ec3-afe1-80376bc8cdad" ], "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": "b9be7b99-c04a-444b-b7e2-e2138885c4fe", "Name": "sample string 10" }, { "ResourceTypeIdentity": "98fbb467-43d9-435c-8760-9a080b8556a4", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "323e6341-e821-4bb6-a41a-806f02a7c91f", "ResourceRestrictionIdentity": "98009ea0-067e-4750-972d-2501907def31", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "91023d20-5dfa-46e1-97fe-deb90a101682", "197bca2f-b2fc-4b7b-bfe7-840e0fe92c9a" ], "BookingApprovers": { "PermissionGroupIdentities": [ "ceed5db3-dbcb-4a5a-863f-fa134f3e1444", "31213f49-c986-4ec3-afe1-80376bc8cdad" ], "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": "b9be7b99-c04a-444b-b7e2-e2138885c4fe", "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": "dc40ab19-72ad-40f6-9960-9668e3ad0dba" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.