GET api/BookingRequests?startRange={startRange}&endRange={endRange}&clearCache={clearCache}

Request Information

URI Parameters

Name	Type	Additional information
startRange	date	Required
endRange	date	Required
clearCache	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of BookingRequest

Name	Type	Additional information
Identity	globally unique identifier	None.
Description	string	None.
Name	string	None.
EventType	string	None.
Owner	string	None.
StartDateTime	date	None.
EndDateTime	date	None.
RecurrencePattern	RecurrencePatternObject	None.
Occurrences	Collection of Occurrence	None.
BookingTypeIdentity	globally unique identifier	None.
FormIdentity	globally unique identifier	None.
OccurrenceGroupIdentity	globally unique identifier	None.
Resources	Collection of BookingResource	None.
CanEdit	boolean	None.
EventIdentity	globally unique identifier	None.
BookerName	string	None.
BookerEmailAddress	string	None.
AdditionalEmailAddresses	Collection of string	None.
Status	string	None.
HasRecurrence	boolean	None.
IsEdited	boolean	None.
Reference	string	None.
BookingRequestFormValue	BookingRequestFormValue	None.
HistoryCount	integer	None.
RevisedBy	string	None.
RevisedByEmailAddress	string	None.
SkipUpdateOccurrencePattern	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Identity": "68f53d20-4246-4ccf-a220-2b969e1eb4bf",
    "Description": "sample string 2",
    "Name": "sample string 3",
    "EventType": "sample string 4",
    "Owner": "sample string 5",
    "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
    "EndDateTime": "2025-03-31T05:02:13.9402828+00:00",
    "RecurrencePattern": {
      "RecurrenceType": 0,
      "EndDateTime": "2025-03-31T05:02:13.9402828+00:00",
      "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
      "Interval": 3,
      "UntilType": 0,
      "UntilDate": "2025-03-31T05:02:13.9402828+00:00",
      "NumberOfOccurrences": 5,
      "RecurrenceDescription": "sample string 6",
      "RecurrencePatternComplexDescription": "sample string 7"
    },
    "Occurrences": [
      {
        "Identity": "205ed624-ca24-4185-b8d2-e0f25709b18e",
        "IsEdited": true,
        "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
        "EndDateTime": "2025-03-31T05:02:13.9402828+00:00"
      },
      {
        "Identity": "205ed624-ca24-4185-b8d2-e0f25709b18e",
        "IsEdited": true,
        "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
        "EndDateTime": "2025-03-31T05:02:13.9402828+00:00"
      }
    ],
    "BookingTypeIdentity": "44b98607-d1f9-40a9-8e17-7f49414755f9",
    "FormIdentity": "f922891a-1381-44e8-8e16-c6ff4a5168b3",
    "OccurrenceGroupIdentity": "3c4b152d-7ee9-40ca-b394-4b369a3cba17",
    "Resources": [
      {
        "ResourceTypeIdentity": "d2110083-15fd-4ac0-aa8e-7915b432a7f5",
        "ResourceTypeName": "sample string 2",
        "ExternalApplicationIdentity": "1ced46d1-53a7-4c30-8ae7-efb6e1fa6e6c",
        "ResourceRestrictionIdentity": "268ca23c-b0cd-4a9d-876e-0de3bd0241e0",
        "IsPrimary": true,
        "Identity": "29368407-436e-48ce-a4a1-babe1bb53055",
        "Name": "sample string 7"
      },
      {
        "ResourceTypeIdentity": "d2110083-15fd-4ac0-aa8e-7915b432a7f5",
        "ResourceTypeName": "sample string 2",
        "ExternalApplicationIdentity": "1ced46d1-53a7-4c30-8ae7-efb6e1fa6e6c",
        "ResourceRestrictionIdentity": "268ca23c-b0cd-4a9d-876e-0de3bd0241e0",
        "IsPrimary": true,
        "Identity": "29368407-436e-48ce-a4a1-babe1bb53055",
        "Name": "sample string 7"
      }
    ],
    "CanEdit": true,
    "EventIdentity": "4d8a59df-25e9-4e45-bc91-7b5d84698677",
    "BookerName": "sample string 13",
    "BookerEmailAddress": "sample string 14",
    "AdditionalEmailAddresses": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 15",
    "HasRecurrence": true,
    "IsEdited": true,
    "Reference": "sample string 17",
    "BookingRequestFormValue": {
      "Identity": "91fcc580-1e6b-45d1-9393-cb2aa13a7cad",
      "Name": "sample string 2",
      "Sections": [
        {
          "Identity": "296ef5ad-ee2e-41d6-a33e-b66f37cd17b1",
          "Name": "sample string 2",
          "Rank": 3,
          "Fields": [
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            },
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            }
          ]
        },
        {
          "Identity": "296ef5ad-ee2e-41d6-a33e-b66f37cd17b1",
          "Name": "sample string 2",
          "Rank": 3,
          "Fields": [
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            },
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            }
          ]
        }
      ]
    },
    "HistoryCount": 18,
    "RevisedBy": "sample string 19",
    "RevisedByEmailAddress": "sample string 20",
    "SkipUpdateOccurrencePattern": true
  },
  {
    "Identity": "68f53d20-4246-4ccf-a220-2b969e1eb4bf",
    "Description": "sample string 2",
    "Name": "sample string 3",
    "EventType": "sample string 4",
    "Owner": "sample string 5",
    "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
    "EndDateTime": "2025-03-31T05:02:13.9402828+00:00",
    "RecurrencePattern": {
      "RecurrenceType": 0,
      "EndDateTime": "2025-03-31T05:02:13.9402828+00:00",
      "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
      "Interval": 3,
      "UntilType": 0,
      "UntilDate": "2025-03-31T05:02:13.9402828+00:00",
      "NumberOfOccurrences": 5,
      "RecurrenceDescription": "sample string 6",
      "RecurrencePatternComplexDescription": "sample string 7"
    },
    "Occurrences": [
      {
        "Identity": "205ed624-ca24-4185-b8d2-e0f25709b18e",
        "IsEdited": true,
        "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
        "EndDateTime": "2025-03-31T05:02:13.9402828+00:00"
      },
      {
        "Identity": "205ed624-ca24-4185-b8d2-e0f25709b18e",
        "IsEdited": true,
        "StartDateTime": "2025-03-31T05:02:13.9402828+00:00",
        "EndDateTime": "2025-03-31T05:02:13.9402828+00:00"
      }
    ],
    "BookingTypeIdentity": "44b98607-d1f9-40a9-8e17-7f49414755f9",
    "FormIdentity": "f922891a-1381-44e8-8e16-c6ff4a5168b3",
    "OccurrenceGroupIdentity": "3c4b152d-7ee9-40ca-b394-4b369a3cba17",
    "Resources": [
      {
        "ResourceTypeIdentity": "d2110083-15fd-4ac0-aa8e-7915b432a7f5",
        "ResourceTypeName": "sample string 2",
        "ExternalApplicationIdentity": "1ced46d1-53a7-4c30-8ae7-efb6e1fa6e6c",
        "ResourceRestrictionIdentity": "268ca23c-b0cd-4a9d-876e-0de3bd0241e0",
        "IsPrimary": true,
        "Identity": "29368407-436e-48ce-a4a1-babe1bb53055",
        "Name": "sample string 7"
      },
      {
        "ResourceTypeIdentity": "d2110083-15fd-4ac0-aa8e-7915b432a7f5",
        "ResourceTypeName": "sample string 2",
        "ExternalApplicationIdentity": "1ced46d1-53a7-4c30-8ae7-efb6e1fa6e6c",
        "ResourceRestrictionIdentity": "268ca23c-b0cd-4a9d-876e-0de3bd0241e0",
        "IsPrimary": true,
        "Identity": "29368407-436e-48ce-a4a1-babe1bb53055",
        "Name": "sample string 7"
      }
    ],
    "CanEdit": true,
    "EventIdentity": "4d8a59df-25e9-4e45-bc91-7b5d84698677",
    "BookerName": "sample string 13",
    "BookerEmailAddress": "sample string 14",
    "AdditionalEmailAddresses": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 15",
    "HasRecurrence": true,
    "IsEdited": true,
    "Reference": "sample string 17",
    "BookingRequestFormValue": {
      "Identity": "91fcc580-1e6b-45d1-9393-cb2aa13a7cad",
      "Name": "sample string 2",
      "Sections": [
        {
          "Identity": "296ef5ad-ee2e-41d6-a33e-b66f37cd17b1",
          "Name": "sample string 2",
          "Rank": 3,
          "Fields": [
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            },
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            }
          ]
        },
        {
          "Identity": "296ef5ad-ee2e-41d6-a33e-b66f37cd17b1",
          "Name": "sample string 2",
          "Rank": 3,
          "Fields": [
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            },
            {
              "Identity": "c3449cae-893a-4c7b-95e9-34293032987f",
              "FieldType": 0,
              "Rank": 2,
              "Description": "sample string 3",
              "ShortDescription": "sample string 4",
              "Values": [
                {},
                {}
              ]
            }
          ]
        }
      ]
    },
    "HistoryCount": 18,
    "RevisedBy": "sample string 19",
    "RevisedByEmailAddress": "sample string 20",
    "SkipUpdateOccurrencePattern": true
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.