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": "5ec449c7-61a8-4635-910a-463096fec85d",
"Name": "sample string 2",
"Description": "sample string 3",
"Sections": [
{
"Identity": "543efa10-ef5f-4e11-93e9-43184ca9740e",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "297e7761-418d-4f19-8584-c2a1bfce6114",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "297e7761-418d-4f19-8584-c2a1bfce6114",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
},
{
"Identity": "543efa10-ef5f-4e11-93e9-43184ca9740e",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "297e7761-418d-4f19-8584-c2a1bfce6114",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "297e7761-418d-4f19-8584-c2a1bfce6114",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
}
],
"AssociatedBookingTypes": [
{
"BookingForm": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"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": "74eee2dc-aca0-41ed-b430-ee8a736a9c6f",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "74eee2dc-aca0-41ed-b430-ee8a736a9c6f",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "b157e885-8e21-4390-8e0a-42206d812611",
"ResourceType": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "b157e885-8e21-4390-8e0a-42206d812611",
"ResourceType": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"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": "a91e9ab0-9fcd-4b51-861a-2c2d904bc4e1",
"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": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"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": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
]
}
],
"Identity": "bc7d8828-0731-4e1c-92a4-0cf95ff18925",
"Name": "sample string 27"
},
{
"BookingForm": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"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": "74eee2dc-aca0-41ed-b430-ee8a736a9c6f",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "74eee2dc-aca0-41ed-b430-ee8a736a9c6f",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "b157e885-8e21-4390-8e0a-42206d812611",
"ResourceType": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "b157e885-8e21-4390-8e0a-42206d812611",
"ResourceType": {
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"Name": "sample string 2"
},
{
"Identity": "a787809c-141c-4cbc-b4d1-70383fe4df56",
"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": "a91e9ab0-9fcd-4b51-861a-2c2d904bc4e1",
"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": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"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": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "05dd0ce3-c425-414b-97ce-d67ecd127092",
"Name": "sample string 2"
}
]
}
],
"Identity": "bc7d8828-0731-4e1c-92a4-0cf95ff18925",
"Name": "sample string 27"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.