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": "f57197d3-c778-4f19-8be6-cc70393cfec9",
"Name": "sample string 2",
"Description": "sample string 3",
"Sections": [
{
"Identity": "002e5d9f-49f5-41b1-b4f5-c0c5cb545be7",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "59637e9f-0ac2-4caf-a630-5fab6fdac625",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "59637e9f-0ac2-4caf-a630-5fab6fdac625",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
},
{
"Identity": "002e5d9f-49f5-41b1-b4f5-c0c5cb545be7",
"Name": "sample string 2",
"Rank": 3,
"Fields": [
{
"Identity": "59637e9f-0ac2-4caf-a630-5fab6fdac625",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
},
{
"Identity": "59637e9f-0ac2-4caf-a630-5fab6fdac625",
"Rank": 2,
"Description": "sample string 3",
"FieldType": 0,
"IsActive": true
}
]
}
],
"AssociatedBookingTypes": [
{
"BookingForm": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"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": "8caee3aa-172e-4b14-9f7b-48e90a103e7f",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "8caee3aa-172e-4b14-9f7b-48e90a103e7f",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "9bb2284c-da64-43bf-99c1-bcfd031af92d",
"ResourceType": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "9bb2284c-da64-43bf-99c1-bcfd031af92d",
"ResourceType": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"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": "64f454da-fb9c-459e-b900-159b3ee1af45",
"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": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"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": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
]
}
],
"Identity": "7f82f6d8-e4c6-446c-add8-e5032eb94664",
"Name": "sample string 27"
},
{
"BookingForm": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"BasePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"BoboPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"CopyBookingPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"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": "8caee3aa-172e-4b14-9f7b-48e90a103e7f",
"Name": "sample string 2"
},
{
"EditPermissionType": 0,
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "8caee3aa-172e-4b14-9f7b-48e90a103e7f",
"Name": "sample string 2"
}
],
"Description": "sample string 1",
"ResourceRestrictionRules": [
{
"Name": "sample string 1",
"Identity": "9bb2284c-da64-43bf-99c1-bcfd031af92d",
"ResourceType": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
}
],
"AllowResourceSelection": true,
"IsPrimary": true
},
{
"Name": "sample string 1",
"Identity": "9bb2284c-da64-43bf-99c1-bcfd031af92d",
"ResourceType": {
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
"Min": 3,
"Max": 4,
"ResourceGroups": [
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"Name": "sample string 2"
},
{
"Identity": "0185d22e-db96-428b-9beb-2182ebc08d83",
"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": "64f454da-fb9c-459e-b900-159b3ee1af45",
"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": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"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": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "21a8b573-de91-461d-aa86-42fac0d9489a",
"Name": "sample string 2"
}
]
}
],
"Identity": "7f82f6d8-e4c6-446c-add8-e5032eb94664",
"Name": "sample string 27"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.