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": "4043bf25-e961-4bd6-a664-4e91c8bcd3da", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-07-01T11:31:25.3346786+00:00", "EndDateTime": "2025-07-01T11:31:25.3346786+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-07-01T11:31:25.3346786+00:00", "StartDateTime": "2025-07-01T11:31:25.3346786+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-07-01T11:31:25.3346786+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "3afbda5c-c6a7-4970-a0e6-55e472fb213f", "IsEdited": true, "StartDateTime": "2025-07-01T11:31:25.3346786+00:00", "EndDateTime": "2025-07-01T11:31:25.3346786+00:00" }, { "Identity": "3afbda5c-c6a7-4970-a0e6-55e472fb213f", "IsEdited": true, "StartDateTime": "2025-07-01T11:31:25.3346786+00:00", "EndDateTime": "2025-07-01T11:31:25.3346786+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "d45d046a-11fe-4a67-b985-165ac88e451a", "StartInfo": { "StartedDateTime": "2025-07-01T11:31:25.3346786+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-07-01T11:31:25.3346786+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "d45d046a-11fe-4a67-b985-165ac88e451a", "StartInfo": { "StartedDateTime": "2025-07-01T11:31:25.3346786+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-07-01T11:31:25.3346786+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "fd12f145-4d78-492b-afd0-52ee2ef76172", "FormIdentity": "d6412166-0a35-4312-9813-f8bf03915dff", "OccurrenceGroupIdentity": "90af1f9c-a1ee-46b4-b10c-de2e568bfe5e", "Resources": [ { "ResourceTypeIdentity": "7aabe2eb-6e57-4bba-af71-8fab60b65aa6", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "b3554ed1-2b6f-402c-9c04-82bb0aae878f", "ResourceRestrictionIdentity": "df53859d-d881-4cb6-bc89-3ed3844db2ef", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "7aad0827-8377-4254-8e1a-8fc56043d0bf", "53a958a3-3d12-4641-b2a1-55e1e93918fa" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2862e748-4ec3-43aa-83e6-c1ee8400b433", "78129416-6ae7-4053-bb96-8ad50066ee57" ], "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": "b73d171d-52eb-48b9-b0c2-5f8edab0e330", "Name": "sample string 10" }, { "ResourceTypeIdentity": "7aabe2eb-6e57-4bba-af71-8fab60b65aa6", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "b3554ed1-2b6f-402c-9c04-82bb0aae878f", "ResourceRestrictionIdentity": "df53859d-d881-4cb6-bc89-3ed3844db2ef", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "7aad0827-8377-4254-8e1a-8fc56043d0bf", "53a958a3-3d12-4641-b2a1-55e1e93918fa" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2862e748-4ec3-43aa-83e6-c1ee8400b433", "78129416-6ae7-4053-bb96-8ad50066ee57" ], "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": "b73d171d-52eb-48b9-b0c2-5f8edab0e330", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "7904773b-0431-46cd-87a7-34ac94aa6286", "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": "d2637d1b-d858-41c2-a371-ee324463937f", "Name": "sample string 2", "Sections": [ { "Identity": "02c63799-9209-444e-b606-209626ebb21a", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "940b96a5-a9f8-4bf8-bc85-9d63ababc194", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "940b96a5-a9f8-4bf8-bc85-9d63ababc194", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "02c63799-9209-444e-b606-209626ebb21a", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "940b96a5-a9f8-4bf8-bc85-9d63ababc194", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "940b96a5-a9f8-4bf8-bc85-9d63ababc194", "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": "3dc8f1b2-cad0-46e2-b9e5-33df1445efbe", "Name": "sample string 2" }, { "Identity": "3dc8f1b2-cad0-46e2-b9e5-33df1445efbe", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "3dc8f1b2-cad0-46e2-b9e5-33df1445efbe", "Name": "sample string 2" }, { "Identity": "3dc8f1b2-cad0-46e2-b9e5-33df1445efbe", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "7aabe2eb-6e57-4bba-af71-8fab60b65aa6", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "b3554ed1-2b6f-402c-9c04-82bb0aae878f", "ResourceRestrictionIdentity": "df53859d-d881-4cb6-bc89-3ed3844db2ef", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "7aad0827-8377-4254-8e1a-8fc56043d0bf", "53a958a3-3d12-4641-b2a1-55e1e93918fa" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2862e748-4ec3-43aa-83e6-c1ee8400b433", "78129416-6ae7-4053-bb96-8ad50066ee57" ], "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": "b73d171d-52eb-48b9-b0c2-5f8edab0e330", "Name": "sample string 10" }, { "ResourceTypeIdentity": "7aabe2eb-6e57-4bba-af71-8fab60b65aa6", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "b3554ed1-2b6f-402c-9c04-82bb0aae878f", "ResourceRestrictionIdentity": "df53859d-d881-4cb6-bc89-3ed3844db2ef", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "7aad0827-8377-4254-8e1a-8fc56043d0bf", "53a958a3-3d12-4641-b2a1-55e1e93918fa" ], "BookingApprovers": { "PermissionGroupIdentities": [ "2862e748-4ec3-43aa-83e6-c1ee8400b433", "78129416-6ae7-4053-bb96-8ad50066ee57" ], "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": "b73d171d-52eb-48b9-b0c2-5f8edab0e330", "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": "eb3bab1a-1eff-4c7d-a1f6-227fc6243c21" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.