GET api/BookingRequests/{bookingRequestIdentity}/Occurrences/{id}?checkResourceRestrictions={checkResourceRestrictions}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bookingRequestIdentity | string |
Required |
|
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": "2dd38ce8-0f08-455b-b035-03864b8a52b6", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2025-09-05T18:58:52.9808108+00:00", "EndDateTime": "2025-09-05T18:58:52.9808108+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2025-09-05T18:58:52.9808108+00:00", "StartDateTime": "2025-09-05T18:58:52.9808108+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2025-09-05T18:58:52.9808108+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "268be82c-3359-4a0e-a6c6-de9b346e8641", "IsEdited": true, "StartDateTime": "2025-09-05T18:58:52.9808108+00:00", "EndDateTime": "2025-09-05T18:58:52.9808108+00:00" }, { "Identity": "268be82c-3359-4a0e-a6c6-de9b346e8641", "IsEdited": true, "StartDateTime": "2025-09-05T18:58:52.9808108+00:00", "EndDateTime": "2025-09-05T18:58:52.9808108+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "d33c9771-7c80-4566-aac9-001c25e7f427", "StartInfo": { "StartedDateTime": "2025-09-05T18:58:52.9808108+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-05T18:58:52.9808108+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "d33c9771-7c80-4566-aac9-001c25e7f427", "StartInfo": { "StartedDateTime": "2025-09-05T18:58:52.9808108+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2025-09-05T18:58:52.9808108+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "8a477adb-e0ef-4811-b159-13a46df7439e", "FormIdentity": "fc01a7aa-d5bc-4139-9c44-e0b7d51f8960", "OccurrenceGroupIdentity": "b00f34b7-df86-4c0f-b91d-1f132365557d", "Resources": [ { "ResourceTypeIdentity": "b6829194-1948-4f79-97c1-2aed7df25dc3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "21cb278c-d57f-4126-bc39-0f0072d3b763", "ResourceRestrictionIdentity": "90b1427c-917f-4614-86ee-9f47495e7c12", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "9fe2c3fa-8ec6-47b4-b4c2-8856541e7680", "bb0c9f4e-6864-41c7-9fa0-a99c39eee01c" ], "BookingApprovers": { "PermissionGroupIdentities": [ "28ba10c4-716b-4f27-8b8e-7748e077d5f9", "1718fe1c-aaa2-48ff-aa2b-cd80ccfdafcf" ], "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": "7d2cb37f-9b4c-4ea0-bcd3-4604438eb5e1", "Name": "sample string 10" }, { "ResourceTypeIdentity": "b6829194-1948-4f79-97c1-2aed7df25dc3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "21cb278c-d57f-4126-bc39-0f0072d3b763", "ResourceRestrictionIdentity": "90b1427c-917f-4614-86ee-9f47495e7c12", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "9fe2c3fa-8ec6-47b4-b4c2-8856541e7680", "bb0c9f4e-6864-41c7-9fa0-a99c39eee01c" ], "BookingApprovers": { "PermissionGroupIdentities": [ "28ba10c4-716b-4f27-8b8e-7748e077d5f9", "1718fe1c-aaa2-48ff-aa2b-cd80ccfdafcf" ], "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": "7d2cb37f-9b4c-4ea0-bcd3-4604438eb5e1", "Name": "sample string 10" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "CanCopy": true, "EventIdentity": "5d2cf20a-602d-45c0-825a-ca0d24336ad0", "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": "672a2b22-8aa6-4bfc-b5a8-ff603a498cf0", "Name": "sample string 2", "Sections": [ { "Identity": "9ed201d8-42b2-40f9-b499-c4073c956ab9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "f5e47d98-3e4c-4e25-be56-ca19c3b79537", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "f5e47d98-3e4c-4e25-be56-ca19c3b79537", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "9ed201d8-42b2-40f9-b499-c4073c956ab9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "f5e47d98-3e4c-4e25-be56-ca19c3b79537", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "f5e47d98-3e4c-4e25-be56-ca19c3b79537", "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": "d2561a64-7f12-494d-926e-25e47a64df54", "Name": "sample string 2" }, { "Identity": "d2561a64-7f12-494d-926e-25e47a64df54", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "d2561a64-7f12-494d-926e-25e47a64df54", "Name": "sample string 2" }, { "Identity": "d2561a64-7f12-494d-926e-25e47a64df54", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "b6829194-1948-4f79-97c1-2aed7df25dc3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "21cb278c-d57f-4126-bc39-0f0072d3b763", "ResourceRestrictionIdentity": "90b1427c-917f-4614-86ee-9f47495e7c12", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "9fe2c3fa-8ec6-47b4-b4c2-8856541e7680", "bb0c9f4e-6864-41c7-9fa0-a99c39eee01c" ], "BookingApprovers": { "PermissionGroupIdentities": [ "28ba10c4-716b-4f27-8b8e-7748e077d5f9", "1718fe1c-aaa2-48ff-aa2b-cd80ccfdafcf" ], "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": "7d2cb37f-9b4c-4ea0-bcd3-4604438eb5e1", "Name": "sample string 10" }, { "ResourceTypeIdentity": "b6829194-1948-4f79-97c1-2aed7df25dc3", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "21cb278c-d57f-4126-bc39-0f0072d3b763", "ResourceRestrictionIdentity": "90b1427c-917f-4614-86ee-9f47495e7c12", "IsPrimary": true, "ResourceAddedExternally": true, "ImageUri": "http://webapihelppage6.com", "Approvers": [ "9fe2c3fa-8ec6-47b4-b4c2-8856541e7680", "bb0c9f4e-6864-41c7-9fa0-a99c39eee01c" ], "BookingApprovers": { "PermissionGroupIdentities": [ "28ba10c4-716b-4f27-8b8e-7748e077d5f9", "1718fe1c-aaa2-48ff-aa2b-cd80ccfdafcf" ], "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": "7d2cb37f-9b4c-4ea0-bcd3-4604438eb5e1", "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": "73c40db0-d2a2-4034-af0a-86d123edecdf" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.