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. |
Response Formats
application/json, text/json
Sample:
{
"Identity": "4beed73e-0f74-4d2c-be31-c3ddd23137dd",
"Name": "sample string 2",
"Description": "sample string 3",
"Sections": [
{
"Identity": "33be17d4-bc4d-4729-8645-cd0232faeea2",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "04f1c78a-8147-44b3-950f-fee1d6d3f51c",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "04f1c78a-8147-44b3-950f-fee1d6d3f51c",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
},
{
"Identity": "33be17d4-bc4d-4729-8645-cd0232faeea2",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "04f1c78a-8147-44b3-950f-fee1d6d3f51c",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "04f1c78a-8147-44b3-950f-fee1d6d3f51c",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
}
],
"AssociatedBookingTypes": [
{
"BookingForm": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"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": "e3e91546-38e8-44b3-af70-33a677748245",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "e3e91546-38e8-44b3-af70-33a677748245",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "c207a284-d9b5-40ac-80fb-92315d54fab8",
"ResourceType": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "c207a284-d9b5-40ac-80fb-92315d54fab8",
"ResourceType": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"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": "718993dd-7ff2-473a-a699-687779b25c82",
"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": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"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": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
]
}
],
"Identity": "a2d8bd05-3b84-42e8-92d4-0c82d7b44c11",
"Name": "sample string 27"
},
{
"BookingForm": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"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": "e3e91546-38e8-44b3-af70-33a677748245",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "e3e91546-38e8-44b3-af70-33a677748245",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "c207a284-d9b5-40ac-80fb-92315d54fab8",
"ResourceType": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "c207a284-d9b5-40ac-80fb-92315d54fab8",
"ResourceType": {
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"Name": "sample string 2"
},
{
"Identity": "6bf53443-4da8-4bc4-a84a-67586411b645",
"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": "718993dd-7ff2-473a-a699-687779b25c82",
"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": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"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": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a6d73a8b-935f-4db3-a89f-d4d459c19924",
"Name": "sample string 2"
}
]
}
],
"Identity": "a2d8bd05-3b84-42e8-92d4-0c82d7b44c11",
"Name": "sample string 27"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.