GET api/BookingForms/{id}?includeDeleted={includeDeleted}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| includeDeleted | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
BookingForm| Name | Description | Type | Additional information |
|---|---|---|---|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| Sections | Collection of Section |
None. |
|
| AssociatedBookingTypes | Collection of BookingType |
None. |
|
| CanDelete | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Identity": "2c6a494b-83c9-40d2-bcd7-4aee49120fe1",
"Name": "sample string 2",
"Description": "sample string 3",
"Sections": [
{
"Identity": "3df6bab7-a665-4bb0-bcc7-e58593e30a7c",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "5f544dd6-084d-457e-b7a8-d8ab45b4510d",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true,
"PreventDelete": true
},
{
"Identity": "5f544dd6-084d-457e-b7a8-d8ab45b4510d",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true,
"PreventDelete": true
}
]
},
{
"Identity": "3df6bab7-a665-4bb0-bcc7-e58593e30a7c",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "5f544dd6-084d-457e-b7a8-d8ab45b4510d",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true,
"PreventDelete": true
},
{
"Identity": "5f544dd6-084d-457e-b7a8-d8ab45b4510d",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true,
"PreventDelete": true
}
]
}
],
"AssociatedBookingTypes": [
{
"BookingForm": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"EditPermissionsGroups": [
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "3763f5ed-3578-4429-b8cb-4960b1a7c8f9",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "3763f5ed-3578-4429-b8cb-4960b1a7c8f9",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "a2f0b913-3f72-4cbe-86e4-2d46ea55fd34",
"ResourceType": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "a2f0b913-3f72-4cbe-86e4-2d46ea55fd34",
"ResourceType": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
}
],
"ImageUri": "http://webapihelppage2.com",
"CanEdit": true,
"CanBookOnBehalfOf": true,
"CanBookAsSomeoneElse": true,
"CanBookRecurring": true,
"HasExternallyManagedResources": true,
"Mode": 0,
"DisabledModeMessage": "sample string 7",
"AlertEnabled": true,
"AlertType": 0,
"AlertMessage": "sample string 9",
"InfoEnabled": true,
"InfoType": 0,
"InfoMessage": "sample string 11",
"HelpEnabled": true,
"HelpMessage": "sample string 13",
"TileMessage": "sample string 14",
"CanEditAll": true,
"CanEditStatus": true,
"CanEditAvailability": true,
"CanEditResourceRestrictions": true,
"CanEditPermissions": true,
"CanEditRules": true,
"CanEditNotifications": true,
"CanEditCalendar": true,
"CanImportBookings": true,
"UseCustomTemplates": true,
"CalendarOptions": {
"Identity": "5490c022-a576-40ea-a933-2f6ab2393fd9",
"CalendarShowWeekends": true,
"CalendarStartTime": "sample string 3",
"CalendarEndTime": "sample string 4",
"CalendarBookingTimes": 0,
"BookingSpanMultipleDays": true,
"UseCustomCalendarOptions": true
},
"ImportPermissions": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"ExchangeSync": true,
"RecurringPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
]
}
],
"Identity": "746369a0-819a-4e38-aa4e-a77872821bad",
"Name": "sample string 27"
},
{
"BookingForm": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"EditPermissionsGroups": [
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "3763f5ed-3578-4429-b8cb-4960b1a7c8f9",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "3763f5ed-3578-4429-b8cb-4960b1a7c8f9",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "a2f0b913-3f72-4cbe-86e4-2d46ea55fd34",
"ResourceType": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "a2f0b913-3f72-4cbe-86e4-2d46ea55fd34",
"ResourceType": {
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
},
{
"Identity": "b4a55ce9-17ea-4d92-bc26-908d936cc638",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
}
],
"ImageUri": "http://webapihelppage2.com",
"CanEdit": true,
"CanBookOnBehalfOf": true,
"CanBookAsSomeoneElse": true,
"CanBookRecurring": true,
"HasExternallyManagedResources": true,
"Mode": 0,
"DisabledModeMessage": "sample string 7",
"AlertEnabled": true,
"AlertType": 0,
"AlertMessage": "sample string 9",
"InfoEnabled": true,
"InfoType": 0,
"InfoMessage": "sample string 11",
"HelpEnabled": true,
"HelpMessage": "sample string 13",
"TileMessage": "sample string 14",
"CanEditAll": true,
"CanEditStatus": true,
"CanEditAvailability": true,
"CanEditResourceRestrictions": true,
"CanEditPermissions": true,
"CanEditRules": true,
"CanEditNotifications": true,
"CanEditCalendar": true,
"CanImportBookings": true,
"UseCustomTemplates": true,
"CalendarOptions": {
"Identity": "5490c022-a576-40ea-a933-2f6ab2393fd9",
"CalendarShowWeekends": true,
"CalendarStartTime": "sample string 3",
"CalendarEndTime": "sample string 4",
"CalendarBookingTimes": 0,
"BookingSpanMultipleDays": true,
"UseCustomCalendarOptions": true
},
"ImportPermissions": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"ExchangeSync": true,
"RecurringPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "699230e0-81c4-4815-9d39-71439659fee0",
"Name": "sample string 2"
}
]
}
],
"Identity": "746369a0-819a-4e38-aa4e-a77872821bad",
"Name": "sample string 27"
}
],
"CanDelete": true
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.