GET api/BookingTypes/{bookingTypeIdentity}/Rules

Request Information

URI Parameters

Name	Description	Type	Additional information
bookingTypeIdentity		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of BookingRule

Name	Type	Additional information
Identity	globally unique identifier	None.
RuleType	BookingRuleType	None.
Properties	Collection of BookingRuleDatum	None.
AppliesTo	Collection of NamedObject	None.
RunOnCreate	boolean	None.
RunOnUpdate	boolean	None.
RunOnDelete	boolean	None.
FailureMessage	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Identity": "df305e6c-3b02-4b2f-9cbf-7aeadd2bd232",
    "RuleType": {
      "Properties": [
        {
          "Name": "sample string 1",
          "ValueType": "sample string 2",
          "ValueChoices": [
            "sample string 1",
            "sample string 2"
          ],
          "Identity": "e3fbc5fb-05a8-49ad-9897-1fabb4b2a531",
          "StartRange": true,
          "EndRange": true
        },
        {
          "Name": "sample string 1",
          "ValueType": "sample string 2",
          "ValueChoices": [
            "sample string 1",
            "sample string 2"
          ],
          "Identity": "e3fbc5fb-05a8-49ad-9897-1fabb4b2a531",
          "StartRange": true,
          "EndRange": true
        }
      ],
      "RunOnUpdateAsCreate": true,
      "RunOnCreateType": 0,
      "RunOnUpdateType": 0,
      "RunOnDeleteType": 0,
      "Identity": "ae17309c-e735-4b93-b0b0-68bb29c3c712",
      "Name": "sample string 3"
    },
    "Properties": [
      {
        "Value": {},
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "StartRange": true,
        "EndRange": true,
        "Identity": "b85decf3-e41d-41cf-8f10-0982b41da2d9",
        "Name": "sample string 6"
      },
      {
        "Value": {},
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "StartRange": true,
        "EndRange": true,
        "Identity": "b85decf3-e41d-41cf-8f10-0982b41da2d9",
        "Name": "sample string 6"
      }
    ],
    "AppliesTo": [
      {
        "Identity": "85f357ea-4c8e-4ced-aab6-1315b83594a2",
        "Name": "sample string 2"
      },
      {
        "Identity": "85f357ea-4c8e-4ced-aab6-1315b83594a2",
        "Name": "sample string 2"
      }
    ],
    "RunOnCreate": true,
    "RunOnUpdate": true,
    "RunOnDelete": true,
    "FailureMessage": "sample string 5"
  },
  {
    "Identity": "df305e6c-3b02-4b2f-9cbf-7aeadd2bd232",
    "RuleType": {
      "Properties": [
        {
          "Name": "sample string 1",
          "ValueType": "sample string 2",
          "ValueChoices": [
            "sample string 1",
            "sample string 2"
          ],
          "Identity": "e3fbc5fb-05a8-49ad-9897-1fabb4b2a531",
          "StartRange": true,
          "EndRange": true
        },
        {
          "Name": "sample string 1",
          "ValueType": "sample string 2",
          "ValueChoices": [
            "sample string 1",
            "sample string 2"
          ],
          "Identity": "e3fbc5fb-05a8-49ad-9897-1fabb4b2a531",
          "StartRange": true,
          "EndRange": true
        }
      ],
      "RunOnUpdateAsCreate": true,
      "RunOnCreateType": 0,
      "RunOnUpdateType": 0,
      "RunOnDeleteType": 0,
      "Identity": "ae17309c-e735-4b93-b0b0-68bb29c3c712",
      "Name": "sample string 3"
    },
    "Properties": [
      {
        "Value": {},
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "StartRange": true,
        "EndRange": true,
        "Identity": "b85decf3-e41d-41cf-8f10-0982b41da2d9",
        "Name": "sample string 6"
      },
      {
        "Value": {},
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "StartRange": true,
        "EndRange": true,
        "Identity": "b85decf3-e41d-41cf-8f10-0982b41da2d9",
        "Name": "sample string 6"
      }
    ],
    "AppliesTo": [
      {
        "Identity": "85f357ea-4c8e-4ced-aab6-1315b83594a2",
        "Name": "sample string 2"
      },
      {
        "Identity": "85f357ea-4c8e-4ced-aab6-1315b83594a2",
        "Name": "sample string 2"
      }
    ],
    "RunOnCreate": true,
    "RunOnUpdate": true,
    "RunOnDelete": true,
    "FailureMessage": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBookingRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <BookingRule>
    <AppliesTo xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>85f357ea-4c8e-4ced-aab6-1315b83594a2</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>85f357ea-4c8e-4ced-aab6-1315b83594a2</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </AppliesTo>
    <FailureMessage>sample string 5</FailureMessage>
    <Identity>df305e6c-3b02-4b2f-9cbf-7aeadd2bd232</Identity>
    <Properties>
      <BookingRuleDatum>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b85decf3-e41d-41cf-8f10-0982b41da2d9</Identity>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 6</Name>
        <EndRange>true</EndRange>
        <StartRange>true</StartRange>
        <Value />
        <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </ValueChoices>
        <ValueType>sample string 2</ValueType>
      </BookingRuleDatum>
      <BookingRuleDatum>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b85decf3-e41d-41cf-8f10-0982b41da2d9</Identity>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 6</Name>
        <EndRange>true</EndRange>
        <StartRange>true</StartRange>
        <Value />
        <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </ValueChoices>
        <ValueType>sample string 2</ValueType>
      </BookingRuleDatum>
    </Properties>
    <RuleType>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">ae17309c-e735-4b93-b0b0-68bb29c3c712</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
      <Properties>
        <BookingRuleTypeProperty>
          <EndRange>true</EndRange>
          <Identity>e3fbc5fb-05a8-49ad-9897-1fabb4b2a531</Identity>
          <Name>sample string 1</Name>
          <StartRange>true</StartRange>
          <ValueChoices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ValueChoices>
          <ValueType>sample string 2</ValueType>
        </BookingRuleTypeProperty>
        <BookingRuleTypeProperty>
          <EndRange>true</EndRange>
          <Identity>e3fbc5fb-05a8-49ad-9897-1fabb4b2a531</Identity>
          <Name>sample string 1</Name>
          <StartRange>true</StartRange>
          <ValueChoices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ValueChoices>
          <ValueType>sample string 2</ValueType>
        </BookingRuleTypeProperty>
      </Properties>
      <RunOnCreateType>Never</RunOnCreateType>
      <RunOnDeleteType>Never</RunOnDeleteType>
      <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
      <RunOnUpdateType>Never</RunOnUpdateType>
    </RuleType>
    <RunOnCreate>true</RunOnCreate>
    <RunOnDelete>true</RunOnDelete>
    <RunOnUpdate>true</RunOnUpdate>
  </BookingRule>
  <BookingRule>
    <AppliesTo xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>85f357ea-4c8e-4ced-aab6-1315b83594a2</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>85f357ea-4c8e-4ced-aab6-1315b83594a2</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </AppliesTo>
    <FailureMessage>sample string 5</FailureMessage>
    <Identity>df305e6c-3b02-4b2f-9cbf-7aeadd2bd232</Identity>
    <Properties>
      <BookingRuleDatum>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b85decf3-e41d-41cf-8f10-0982b41da2d9</Identity>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 6</Name>
        <EndRange>true</EndRange>
        <StartRange>true</StartRange>
        <Value />
        <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </ValueChoices>
        <ValueType>sample string 2</ValueType>
      </BookingRuleDatum>
      <BookingRuleDatum>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b85decf3-e41d-41cf-8f10-0982b41da2d9</Identity>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 6</Name>
        <EndRange>true</EndRange>
        <StartRange>true</StartRange>
        <Value />
        <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </ValueChoices>
        <ValueType>sample string 2</ValueType>
      </BookingRuleDatum>
    </Properties>
    <RuleType>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">ae17309c-e735-4b93-b0b0-68bb29c3c712</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
      <Properties>
        <BookingRuleTypeProperty>
          <EndRange>true</EndRange>
          <Identity>e3fbc5fb-05a8-49ad-9897-1fabb4b2a531</Identity>
          <Name>sample string 1</Name>
          <StartRange>true</StartRange>
          <ValueChoices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ValueChoices>
          <ValueType>sample string 2</ValueType>
        </BookingRuleTypeProperty>
        <BookingRuleTypeProperty>
          <EndRange>true</EndRange>
          <Identity>e3fbc5fb-05a8-49ad-9897-1fabb4b2a531</Identity>
          <Name>sample string 1</Name>
          <StartRange>true</StartRange>
          <ValueChoices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ValueChoices>
          <ValueType>sample string 2</ValueType>
        </BookingRuleTypeProperty>
      </Properties>
      <RunOnCreateType>Never</RunOnCreateType>
      <RunOnDeleteType>Never</RunOnDeleteType>
      <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
      <RunOnUpdateType>Never</RunOnUpdateType>
    </RuleType>
    <RunOnCreate>true</RunOnCreate>
    <RunOnDelete>true</RunOnDelete>
    <RunOnUpdate>true</RunOnUpdate>
  </BookingRule>
</ArrayOfBookingRule>