GET api/BookingRequests?startRange={startRange}&endRange={endRange}&clearCache={clearCache}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startRange | date |
Required |
|
endRange | date |
Required |
|
clearCache | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of 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. |
|
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. |
Response Formats
application/json, text/json
Sample:
[ { "Identity": "78982acf-8f85-4aeb-8fa2-9bb211cf9f19", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2024-11-21T09:01:08.7718348+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "92bdcc74-c319-4a61-9c96-57baedcd0652", "IsEdited": true, "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00" }, { "Identity": "92bdcc74-c319-4a61-9c96-57baedcd0652", "IsEdited": true, "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "47b3d780-56b3-465c-8cba-17cd48720ecd", "StartInfo": { "StartedDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "47b3d780-56b3-465c-8cba-17cd48720ecd", "StartInfo": { "StartedDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "ff0caf8c-b5bb-41b5-8bca-2dbf98a83f5e", "FormIdentity": "db397805-e562-4549-b097-2a9de476beff", "OccurrenceGroupIdentity": "08b2bf3a-ffd9-48aa-b6ad-ef9fae60e96f", "Resources": [ { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" }, { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "EventIdentity": "85d4da2e-ebe8-4fe1-a60c-2a4834c878b8", "BookerName": "sample string 15", "BookerEmailAddress": "sample string 16", "AdditionalEmailAddresses": [ "sample string 1", "sample string 2" ], "Status": "sample string 17", "HasRecurrence": true, "IsEdited": true, "Reference": "sample string 19", "BookingRequestFormValue": { "Identity": "2cb6e5d8-802a-4986-83a2-14c93b08634d", "Name": "sample string 2", "Sections": [ { "Identity": "ee32d43d-6fff-4d0e-9750-9cca50615ac9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "ee32d43d-6fff-4d0e-9750-9cca50615ac9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] } ] }, "HistoryCount": 20, "RevisedBy": "sample string 21", "RevisedByEmailAddress": "sample string 22", "SkipUpdateOccurrencePattern": true, "IsCurrentlyActive": true, "EditRestrictions": [ { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" }, { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" }, { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" }, { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" } ], "IsImport": true, "ImportedBy": "sample string 26", "ImportedByEmailAddress": "sample string 27", "Source": "sample string 28", "PrimaryResourceChanged": true, "PrimaryResourceChangedByEmailAddress": "sample string 30" }, { "Identity": "78982acf-8f85-4aeb-8fa2-9bb211cf9f19", "Description": "sample string 2", "Name": "sample string 3", "EventType": "sample string 4", "Owner": "sample string 5", "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00", "RecurrencePattern": { "RecurrenceType": 0, "EndDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "Interval": 3, "UntilType": 0, "UntilDate": "2024-11-21T09:01:08.7718348+00:00", "NumberOfOccurrences": 5, "RecurrenceDescription": "sample string 6", "RecurrencePatternComplexDescription": "sample string 7" }, "Occurrences": [ { "Identity": "92bdcc74-c319-4a61-9c96-57baedcd0652", "IsEdited": true, "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00" }, { "Identity": "92bdcc74-c319-4a61-9c96-57baedcd0652", "IsEdited": true, "StartDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndDateTime": "2024-11-21T09:01:08.7718348+00:00" } ], "BookingExecutions": [ { "OccurrenceIdentity": "47b3d780-56b3-465c-8cba-17cd48720ecd", "StartInfo": { "StartedDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } }, { "OccurrenceIdentity": "47b3d780-56b3-465c-8cba-17cd48720ecd", "StartInfo": { "StartedDateTime": "2024-11-21T09:01:08.7718348+00:00", "StartedByIdentity": "sample string 1", "StartedByName": "sample string 2", "StartedByEmailAddress": "sample string 3", "StartedForm": "sample string 4" }, "EndInfo": { "EndedDateTime": "2024-11-21T09:01:08.7718348+00:00", "EndedByIdentity": "sample string 1", "EndedByName": "sample string 2", "EndedByEmailAddress": "sample string 3", "EndedForm": "sample string 4" } } ], "BookingTypeIdentity": "ff0caf8c-b5bb-41b5-8bca-2dbf98a83f5e", "FormIdentity": "db397805-e562-4549-b097-2a9de476beff", "OccurrenceGroupIdentity": "08b2bf3a-ffd9-48aa-b6ad-ef9fae60e96f", "Resources": [ { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" }, { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" } ], "CanEdit": true, "CanCancel": true, "CanEditEndDateTimeOnly": true, "EventIdentity": "85d4da2e-ebe8-4fe1-a60c-2a4834c878b8", "BookerName": "sample string 15", "BookerEmailAddress": "sample string 16", "AdditionalEmailAddresses": [ "sample string 1", "sample string 2" ], "Status": "sample string 17", "HasRecurrence": true, "IsEdited": true, "Reference": "sample string 19", "BookingRequestFormValue": { "Identity": "2cb6e5d8-802a-4986-83a2-14c93b08634d", "Name": "sample string 2", "Sections": [ { "Identity": "ee32d43d-6fff-4d0e-9750-9cca50615ac9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] }, { "Identity": "ee32d43d-6fff-4d0e-9750-9cca50615ac9", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] }, { "Identity": "80ba4a6a-a8d1-4492-b09b-0be9dbc1a0ac", "FieldType": 0, "Rank": 2, "Description": "sample string 3", "ShortDescription": "sample string 4", "Values": [ {}, {} ] } ] } ] }, "HistoryCount": 20, "RevisedBy": "sample string 21", "RevisedByEmailAddress": "sample string 22", "SkipUpdateOccurrencePattern": true, "IsCurrentlyActive": true, "EditRestrictions": [ { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" }, { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true }, { "MessageKey": "sample string 1", "Message": "sample string 2", "AffectedResources": [ { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" }, { "Identity": "c304a80b-b7e9-4016-9376-996b942a2003", "Name": "sample string 2" } ], "AllowEdit": true, "AppliesToSingleOccurrenceUpdateOnly": true } ], "RefittedResources": [ { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" }, { "ResourceTypeIdentity": "5109f2f8-d019-43cb-86f8-b944bcb9cbff", "ResourceTypeName": "sample string 2", "ExternalApplicationIdentity": "e319fce8-3c84-45f7-b710-b577fe9e1add", "ResourceRestrictionIdentity": "f7765a3c-5496-4ab4-9e28-faca29434e41", "IsPrimary": true, "ImageUri": "http://webapihelppage5.com", "Approvers": [ "0d22462e-036f-4541-9ebc-89bcd6e22abd", "55415b52-d7f5-48ff-bd33-1ffee7f9ccc6" ], "BookingApprovers": { "PermissionGroupIdentities": [ "9edabf61-e9fb-4509-ac2a-b75e9556f79c", "1434862d-37d9-4773-8a90-a399f3084d77" ], "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": "caaa4b4c-302a-414b-adee-e173139a6579", "Name": "sample string 9" } ], "IsImport": true, "ImportedBy": "sample string 26", "ImportedByEmailAddress": "sample string 27", "Source": "sample string 28", "PrimaryResourceChanged": true, "PrimaryResourceChangedByEmailAddress": "sample string 30" } ]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.