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": "2bc49657-2b67-4b33-a4e9-2d5994532238", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-08-31T10:06:23.1382058+00:00", "EndDateTime": "2025-08-31T10:06:23.1382058+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-08-31T10:06:23.1382058+00:00", "StartDateTime": "2025-08-31T10:06:23.1382058+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-08-31T10:06:23.1382058+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "0685073b-d112-463d-968d-6107d22aaa86", "IsEdited": true, "StartDateTime": "2025-08-31T10:06:23.1382058+00:00", "EndDateTime": "2025-08-31T10:06:23.1382058+00:00" }, { "Identity": "0685073b-d112-463d-968d-6107d22aaa86", "IsEdited": true, "StartDateTime": "2025-08-31T10:06:23.1382058+00:00", "EndDateTime": "2025-08-31T10:06:23.1382058+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "887a4a0e-9dd0-422a-b0d4-7b2b4e894d16", "StartInfo": { "StartedDateTime": "2025-08-31T10:06:23.1382058+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-08-31T10:06:23.1382058+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "887a4a0e-9dd0-422a-b0d4-7b2b4e894d16", "StartInfo": { "StartedDateTime": "2025-08-31T10:06:23.1382058+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-08-31T10:06:23.1382058+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "6980a0c4-6b18-49a0-962d-b23c63dfa674", "FormIdentity": "5041d33d-9b5d-4237-b926-26bdabbf3e7b", "OccurrenceGroupIdentity": "5184449b-590f-498b-895f-ec8e32be5ee7", "Resources": [ { "ResourceTypeIdentity": "6b9db98f-b492-472a-a6f4-2026a1fe93d3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "063bd60a-8167-403b-bdec-35a39c2690ea", "ResourceRestrictionIdentity": "9cdfb637-2fac-40b9-a14f-c847d73e2d13", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "404cc344-e47b-4102-84ea-c8783b998d3a", "8153681c-1daa-46bf-a78f-b0e09ce2cff0" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2c5fd36b-321b-49a6-97bb-0c770b1e49f4", "014481d7-9710-48b7-97d2-6783f5491500" ], "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": "5cb27c0f-07fa-4bae-a717-af18ef3c7455", "Name": "sample string 10" }, { "ResourceTypeIdentity": "6b9db98f-b492-472a-a6f4-2026a1fe93d3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "063bd60a-8167-403b-bdec-35a39c2690ea", "ResourceRestrictionIdentity": "9cdfb637-2fac-40b9-a14f-c847d73e2d13", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "404cc344-e47b-4102-84ea-c8783b998d3a", "8153681c-1daa-46bf-a78f-b0e09ce2cff0" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2c5fd36b-321b-49a6-97bb-0c770b1e49f4", "014481d7-9710-48b7-97d2-6783f5491500" ], "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": "5cb27c0f-07fa-4bae-a717-af18ef3c7455", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "5accaad8-a5cb-4b05-9c6d-95959639abe5", "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": "f0d0209c-26a5-4a79-92de-98b76feb2177", "Name": "sample string 2", "Sections": [ { "Identity": "2f0af41e-94e4-4c65-8c2b-a09a65902ee9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "2ca73291-9902-45b0-ba79-d71a2c49b4c5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "2ca73291-9902-45b0-ba79-d71a2c49b4c5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "2f0af41e-94e4-4c65-8c2b-a09a65902ee9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "2ca73291-9902-45b0-ba79-d71a2c49b4c5", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "2ca73291-9902-45b0-ba79-d71a2c49b4c5", "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": "26477e61-b104-45d2-b4f7-cc7fc878b596", "Name": "sample string 2" }, { "Identity": "26477e61-b104-45d2-b4f7-cc7fc878b596", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "26477e61-b104-45d2-b4f7-cc7fc878b596", "Name": "sample string 2" }, { "Identity": "26477e61-b104-45d2-b4f7-cc7fc878b596", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "6b9db98f-b492-472a-a6f4-2026a1fe93d3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "063bd60a-8167-403b-bdec-35a39c2690ea", "ResourceRestrictionIdentity": "9cdfb637-2fac-40b9-a14f-c847d73e2d13", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "404cc344-e47b-4102-84ea-c8783b998d3a", "8153681c-1daa-46bf-a78f-b0e09ce2cff0" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2c5fd36b-321b-49a6-97bb-0c770b1e49f4", "014481d7-9710-48b7-97d2-6783f5491500" ], "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": "5cb27c0f-07fa-4bae-a717-af18ef3c7455", "Name": "sample string 10" }, { "ResourceTypeIdentity": "6b9db98f-b492-472a-a6f4-2026a1fe93d3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "063bd60a-8167-403b-bdec-35a39c2690ea", "ResourceRestrictionIdentity": "9cdfb637-2fac-40b9-a14f-c847d73e2d13", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "404cc344-e47b-4102-84ea-c8783b998d3a", "8153681c-1daa-46bf-a78f-b0e09ce2cff0" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2c5fd36b-321b-49a6-97bb-0c770b1e49f4", "014481d7-9710-48b7-97d2-6783f5491500" ], "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": "5cb27c0f-07fa-4bae-a717-af18ef3c7455", "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": "5f39acad-35d7-4c14-aa0b-00f96e49881a" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.