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
BookingRequest| Name | 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": "e088d96f-a159-42ad-828b-550753b21fe2",
"Description": "sample string 2",
"Name": "sample string 3",
"EventType": "sample string 4",
"Owner": "sample string 5",
"StartDateTime": "2026-01-31T20:16:15.8031961+00:00",
"EndDateTime": "2026-01-31T20:16:15.8031961+00:00",
"RecurrencePattern": {
"RecurrenceType": 0,
"EndDateTime": "2026-01-31T20:16:15.8031961+00:00",
"StartDateTime": "2026-01-31T20:16:15.8031961+00:00",
"Interval": 3,
"UntilType": 0,
"UntilDate": "2026-01-31T20:16:15.8031961+00:00",
"NumberOfOccurrences": 5,
"RecurrenceDescription": "sample string 6",
"RecurrencePatternComplexDescription": "sample string 7"
},
"Occurrences": [
{
"Identity": "5accc93d-4314-49b4-b3da-5a727eb7b822",
"IsEdited": true,
"StartDateTime": "2026-01-31T20:16:15.8031961+00:00",
"EndDateTime": "2026-01-31T20:16:15.8031961+00:00"
},
{
"Identity": "5accc93d-4314-49b4-b3da-5a727eb7b822",
"IsEdited": true,
"StartDateTime": "2026-01-31T20:16:15.8031961+00:00",
"EndDateTime": "2026-01-31T20:16:15.8031961+00:00"
}
],
"BookingExecutions": [
{
"OccurrenceIdentity": "5e627c66-e741-424d-a91b-e5bf84e1e168",
"StartInfo": {
"StartedDateTime": "2026-01-31T20:16:15.8031961+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-01-31T20:16:15.8031961+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
},
{
"OccurrenceIdentity": "5e627c66-e741-424d-a91b-e5bf84e1e168",
"StartInfo": {
"StartedDateTime": "2026-01-31T20:16:15.8031961+00:00",
"StartedByIdentity": "sample string 1",
"StartedByName": "sample string 2",
"StartedByEmailAddress": "sample string 3",
"StartedForm": "sample string 4"
},
"EndInfo": {
"EndedDateTime": "2026-01-31T20:16:15.8031961+00:00",
"EndedByIdentity": "sample string 1",
"EndedByName": "sample string 2",
"EndedByEmailAddress": "sample string 3",
"EndedForm": "sample string 4"
}
}
],
"BookingTypeIdentity": "31ed2062-a770-45a9-b7d5-980285980e3b",
"FormIdentity": "426f72c9-2271-47ce-9e28-1e326ff2ea01",
"OccurrenceGroupIdentity": "9188c285-5119-4dfe-9fa3-0499224b037a",
"Resources": [
{
"ResourceTypeIdentity": "c43e8372-9759-4f0b-9c6c-9a8b01667b45",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "80a533f0-e12e-40d2-8038-8bd2a05095a8",
"ResourceRestrictionIdentity": "ef2f8bec-2662-421a-aa66-619628791a51",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"fb49b87b-944d-4d7c-9b7f-72973e9b2b6f",
"145b0539-1695-4610-a2cd-06a18a29a888"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"dde276af-88cc-4845-9dc2-fbd409f3c8f1",
"5c556364-fca5-4ac6-b30a-86bbbb3d3592"
],
"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": "38d861b0-c964-408e-83cc-5bc65bfb73ef",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "c43e8372-9759-4f0b-9c6c-9a8b01667b45",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "80a533f0-e12e-40d2-8038-8bd2a05095a8",
"ResourceRestrictionIdentity": "ef2f8bec-2662-421a-aa66-619628791a51",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"fb49b87b-944d-4d7c-9b7f-72973e9b2b6f",
"145b0539-1695-4610-a2cd-06a18a29a888"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"dde276af-88cc-4845-9dc2-fbd409f3c8f1",
"5c556364-fca5-4ac6-b30a-86bbbb3d3592"
],
"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": "38d861b0-c964-408e-83cc-5bc65bfb73ef",
"Name": "sample string 10"
}
],
"CanEdit": true,
"CanCancel": true,
"CanEditEndDateTimeOnly": true,
"CanCopy": true,
"EventIdentity": "f422e8a4-ba5c-4ffa-8aa3-6168df83cd00",
"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": "1b5a10e7-74fa-4ce3-b631-d1b6a55f2e46",
"Name": "sample string 2",
"Sections": [
{
"Identity": "2f837b68-8fbf-48db-979f-01d96cae58f4",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "0d891ee0-fa95-44e9-9e8c-53ca361ed18d",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "0d891ee0-fa95-44e9-9e8c-53ca361ed18d",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
}
]
},
{
"Identity": "2f837b68-8fbf-48db-979f-01d96cae58f4",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "0d891ee0-fa95-44e9-9e8c-53ca361ed18d",
"FieldType": 0,
"Rank": 2,
"Description": "sample string 3",
"ShortDescription": "sample string 4",
"Values": [
{},
{}
]
},
{
"Identity": "0d891ee0-fa95-44e9-9e8c-53ca361ed18d",
"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": "9cbe3469-b732-4ba4-a1b5-e59397d223a6",
"Name": "sample string 2"
},
{
"Identity": "9cbe3469-b732-4ba4-a1b5-e59397d223a6",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
},
{
"MessageKey": "sample string 1",
"Message": "sample string 2",
"AffectedResources": [
{
"Identity": "9cbe3469-b732-4ba4-a1b5-e59397d223a6",
"Name": "sample string 2"
},
{
"Identity": "9cbe3469-b732-4ba4-a1b5-e59397d223a6",
"Name": "sample string 2"
}
],
"AllowEdit": true,
"AppliesToSingleOccurrenceUpdateOnly": true
}
],
"RefittedResources": [
{
"ResourceTypeIdentity": "c43e8372-9759-4f0b-9c6c-9a8b01667b45",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "80a533f0-e12e-40d2-8038-8bd2a05095a8",
"ResourceRestrictionIdentity": "ef2f8bec-2662-421a-aa66-619628791a51",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"fb49b87b-944d-4d7c-9b7f-72973e9b2b6f",
"145b0539-1695-4610-a2cd-06a18a29a888"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"dde276af-88cc-4845-9dc2-fbd409f3c8f1",
"5c556364-fca5-4ac6-b30a-86bbbb3d3592"
],
"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": "38d861b0-c964-408e-83cc-5bc65bfb73ef",
"Name": "sample string 10"
},
{
"ResourceTypeIdentity": "c43e8372-9759-4f0b-9c6c-9a8b01667b45",
"ResourceTypeName": "sample string 2",
"ExternalApplicationIdentity": "80a533f0-e12e-40d2-8038-8bd2a05095a8",
"ResourceRestrictionIdentity": "ef2f8bec-2662-421a-aa66-619628791a51",
"IsPrimary": true,
"ResourceAddedExternally": true,
"ImageUri": "http://webapihelppage6.com",
"Approvers": [
"fb49b87b-944d-4d7c-9b7f-72973e9b2b6f",
"145b0539-1695-4610-a2cd-06a18a29a888"
],
"BookingApprovers": {
"PermissionGroupIdentities": [
"dde276af-88cc-4845-9dc2-fbd409f3c8f1",
"5c556364-fca5-4ac6-b30a-86bbbb3d3592"
],
"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": "38d861b0-c964-408e-83cc-5bc65bfb73ef",
"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": "7fc9b8c6-f800-400d-9250-e78019a35d03"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.