GET api/Rules

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BookingRuleType

Name	Type	Additional information
Properties	Collection of BookingRuleTypeProperty	None.
RunOnUpdateAsCreate	boolean	None.
RunOnCreateType	RuleActionType	None.
RunOnUpdateType	RuleActionType	None.
RunOnDeleteType	RuleActionType	None.
RuleGroupRequiresOneValidOnly	boolean	None.
RequiresBookingTypeIdentity	boolean	None.
Identity	globally unique identifier	None.
Name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Properties": [
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "ValueChoicesWithId": [
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          },
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          }
        ],
        "Identity": "5089d49d-66e2-45e1-9338-1152e87fb780",
        "StartRange": true,
        "EndRange": true
      },
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "ValueChoicesWithId": [
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          },
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          }
        ],
        "Identity": "5089d49d-66e2-45e1-9338-1152e87fb780",
        "StartRange": true,
        "EndRange": true
      }
    ],
    "RunOnUpdateAsCreate": true,
    "RunOnCreateType": 0,
    "RunOnUpdateType": 0,
    "RunOnDeleteType": 0,
    "RuleGroupRequiresOneValidOnly": true,
    "RequiresBookingTypeIdentity": true,
    "Identity": "0c4c8867-7fa5-4d59-b7a7-6fd37780ca9b",
    "Name": "sample string 5"
  },
  {
    "Properties": [
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "ValueChoicesWithId": [
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          },
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          }
        ],
        "Identity": "5089d49d-66e2-45e1-9338-1152e87fb780",
        "StartRange": true,
        "EndRange": true
      },
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "ValueChoicesWithId": [
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          },
          {
            "Identity": "fd7abe09-1b26-4d60-9124-ce50c84fcd2b",
            "Name": "sample string 2"
          }
        ],
        "Identity": "5089d49d-66e2-45e1-9338-1152e87fb780",
        "StartRange": true,
        "EndRange": true
      }
    ],
    "RunOnUpdateAsCreate": true,
    "RunOnCreateType": 0,
    "RunOnUpdateType": 0,
    "RunOnDeleteType": 0,
    "RuleGroupRequiresOneValidOnly": true,
    "RequiresBookingTypeIdentity": true,
    "Identity": "0c4c8867-7fa5-4d59-b7a7-6fd37780ca9b",
    "Name": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBookingRuleType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <BookingRuleType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">0c4c8867-7fa5-4d59-b7a7-6fd37780ca9b</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
    <Properties>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>5089d49d-66e2-45e1-9338-1152e87fb780</Identity>
        <Name>sample string 1</Name>
        <StartRange>true</StartRange>
        <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>
        <ValueChoicesWithId xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
        </ValueChoicesWithId>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>5089d49d-66e2-45e1-9338-1152e87fb780</Identity>
        <Name>sample string 1</Name>
        <StartRange>true</StartRange>
        <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>
        <ValueChoicesWithId xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
        </ValueChoicesWithId>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
    </Properties>
    <RequiresBookingTypeIdentity>true</RequiresBookingTypeIdentity>
    <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly>
    <RunOnCreateType>Never</RunOnCreateType>
    <RunOnDeleteType>Never</RunOnDeleteType>
    <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
    <RunOnUpdateType>Never</RunOnUpdateType>
  </BookingRuleType>
  <BookingRuleType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">0c4c8867-7fa5-4d59-b7a7-6fd37780ca9b</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
    <Properties>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>5089d49d-66e2-45e1-9338-1152e87fb780</Identity>
        <Name>sample string 1</Name>
        <StartRange>true</StartRange>
        <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>
        <ValueChoicesWithId xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
        </ValueChoicesWithId>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>5089d49d-66e2-45e1-9338-1152e87fb780</Identity>
        <Name>sample string 1</Name>
        <StartRange>true</StartRange>
        <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>
        <ValueChoicesWithId xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
          <d5p1:NamedObject>
            <d5p1:Identity>fd7abe09-1b26-4d60-9124-ce50c84fcd2b</d5p1:Identity>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:NamedObject>
        </ValueChoicesWithId>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
    </Properties>
    <RequiresBookingTypeIdentity>true</RequiresBookingTypeIdentity>
    <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly>
    <RunOnCreateType>Never</RunOnCreateType>
    <RunOnDeleteType>Never</RunOnDeleteType>
    <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
    <RunOnUpdateType>Never</RunOnUpdateType>
  </BookingRuleType>
</ArrayOfBookingRuleType>