GET api/BookingForms/{id}?includeDeleted={includeDeleted}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

includeDeleted

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

BookingForm
NameDescriptionTypeAdditional 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": "377a9241-c870-492f-a27c-3b924944ec9c",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Sections": [
    {
      "Identity": "142f9156-d4c0-48fe-8c4f-50e5249f9f62",
      "Name": "sample string 2",
      "Rank": 3,
      "Fields": [
        {
          "Identity": "68ced292-4eea-4d74-9cc2-eea0e08f1791",
          "Rank": 2,
          "Description": "sample string 3",
          "FieldType": 0,
          "IsActive": true
        },
        {
          "Identity": "68ced292-4eea-4d74-9cc2-eea0e08f1791",
          "Rank": 2,
          "Description": "sample string 3",
          "FieldType": 0,
          "IsActive": true
        }
      ]
    },
    {
      "Identity": "142f9156-d4c0-48fe-8c4f-50e5249f9f62",
      "Name": "sample string 2",
      "Rank": 3,
      "Fields": [
        {
          "Identity": "68ced292-4eea-4d74-9cc2-eea0e08f1791",
          "Rank": 2,
          "Description": "sample string 3",
          "FieldType": 0,
          "IsActive": true
        },
        {
          "Identity": "68ced292-4eea-4d74-9cc2-eea0e08f1791",
          "Rank": 2,
          "Description": "sample string 3",
          "FieldType": 0,
          "IsActive": true
        }
      ]
    }
  ],
  "AssociatedBookingTypes": [
    {
      "BookingForm": {
        "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
        "Name": "sample string 2"
      },
      "BasePermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "BoboPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "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": "afd53364-8db6-4940-a1d8-a3e808fbd0a6",
          "Name": "sample string 2"
        },
        {
          "EditPermissionType": 0,
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "afd53364-8db6-4940-a1d8-a3e808fbd0a6",
          "Name": "sample string 2"
        }
      ],
      "Description": "sample string 1",
      "ResourceRestrictionRules": [
        {
          "Name": "sample string 1",
          "Identity": "efcd7988-bb0a-4d15-b123-7b7d08c584b0",
          "ResourceType": {
            "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
            "Name": "sample string 2"
          },
          "Min": 3,
          "Max": 4,
          "ResourceGroups": [
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            },
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            }
          ],
          "AllowResourceSelection": true,
          "IsPrimary": true
        },
        {
          "Name": "sample string 1",
          "Identity": "efcd7988-bb0a-4d15-b123-7b7d08c584b0",
          "ResourceType": {
            "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
            "Name": "sample string 2"
          },
          "Min": 3,
          "Max": 4,
          "ResourceGroups": [
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            },
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "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": "adac21c7-f3b1-4513-bf4c-ee27efa946f9",
        "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": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "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": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "ReadPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "WritePermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "BookPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "RequestPermissionGroups": [
        {
          "PermissionTarget": {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
            "Name": "sample string 2"
          },
          "Approvers": [
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            },
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            }
          ]
        },
        {
          "PermissionTarget": {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
            "Name": "sample string 2"
          },
          "Approvers": [
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            },
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            }
          ]
        }
      ],
      "Identity": "3d41521f-de70-4df0-bfd7-b184b2db27ed",
      "Name": "sample string 27"
    },
    {
      "BookingForm": {
        "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
        "Name": "sample string 2"
      },
      "BasePermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "BoboPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "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": "afd53364-8db6-4940-a1d8-a3e808fbd0a6",
          "Name": "sample string 2"
        },
        {
          "EditPermissionType": 0,
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "afd53364-8db6-4940-a1d8-a3e808fbd0a6",
          "Name": "sample string 2"
        }
      ],
      "Description": "sample string 1",
      "ResourceRestrictionRules": [
        {
          "Name": "sample string 1",
          "Identity": "efcd7988-bb0a-4d15-b123-7b7d08c584b0",
          "ResourceType": {
            "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
            "Name": "sample string 2"
          },
          "Min": 3,
          "Max": 4,
          "ResourceGroups": [
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            },
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            }
          ],
          "AllowResourceSelection": true,
          "IsPrimary": true
        },
        {
          "Name": "sample string 1",
          "Identity": "efcd7988-bb0a-4d15-b123-7b7d08c584b0",
          "ResourceType": {
            "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
            "Name": "sample string 2"
          },
          "Min": 3,
          "Max": 4,
          "ResourceGroups": [
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "Name": "sample string 2"
            },
            {
              "Identity": "1ad5d0df-4c4d-4120-ac1f-661181933081",
              "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": "adac21c7-f3b1-4513-bf4c-ee27efa946f9",
        "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": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "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": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "ReadPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "WritePermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "BookPermissionGroups": [
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        },
        {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
          "Name": "sample string 2"
        }
      ],
      "RequestPermissionGroups": [
        {
          "PermissionTarget": {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
            "Name": "sample string 2"
          },
          "Approvers": [
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            },
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            }
          ]
        },
        {
          "PermissionTarget": {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
            "Name": "sample string 2"
          },
          "Approvers": [
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            },
            {
              "PermissionClaim": {
                "ClaimType": "sample string 1",
                "ClaimValue": "sample string 2",
                "ClaimTypeLower": "sample string 1",
                "ClaimValueLower": "sample string 2"
              },
              "Identity": "4a8d8bcc-f017-4cae-8287-c7bcc013d597",
              "Name": "sample string 2"
            }
          ]
        }
      ],
      "Identity": "3d41521f-de70-4df0-bfd7-b184b2db27ed",
      "Name": "sample string 27"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.