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": "465430b6-ce2b-4ec8-a931-05c9c6b6766d",
"Name": "sample string 2",
"Description": "sample string 3",
"Sections": [
{
"Identity": "877f8ded-e3e4-4a2e-8f5a-c7606f06e2ee",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "43109f34-69b6-435c-859e-9b7eeccda6e9",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "43109f34-69b6-435c-859e-9b7eeccda6e9",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
},
{
"Identity": "877f8ded-e3e4-4a2e-8f5a-c7606f06e2ee",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "43109f34-69b6-435c-859e-9b7eeccda6e9",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "43109f34-69b6-435c-859e-9b7eeccda6e9",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
}
],
"AssociatedBookingTypes": [
{
"BookingForm": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"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": "20052771-a7bc-46cc-bbd2-45bdf0387d74",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "20052771-a7bc-46cc-bbd2-45bdf0387d74",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "6358a111-6aca-484d-94d9-af00f19cbf29",
"ResourceType": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "6358a111-6aca-484d-94d9-af00f19cbf29",
"ResourceType": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"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": "6bfe1185-608a-4d05-b91e-a24a7dec81ff",
"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": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"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": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
]
}
],
"Identity": "4f721c16-0bc9-46a5-8356-f467ec313c40",
"Name": "sample string 27"
},
{
"BookingForm": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"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": "20052771-a7bc-46cc-bbd2-45bdf0387d74",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "20052771-a7bc-46cc-bbd2-45bdf0387d74",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "6358a111-6aca-484d-94d9-af00f19cbf29",
"ResourceType": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "6358a111-6aca-484d-94d9-af00f19cbf29",
"ResourceType": {
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"Name": "sample string 2"
},
{
"Identity": "4eb194f5-08ac-42f9-998a-8b425339275c",
"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": "6bfe1185-608a-4d05-b91e-a24a7dec81ff",
"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": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"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": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "a4e378ad-8c83-4707-ab0f-c372c922d70d",
"Name": "sample string 2"
}
]
}
],
"Identity": "4f721c16-0bc9-46a5-8356-f467ec313c40",
"Name": "sample string 27"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.