PUT api/BookingTypes/{bookingTypeIdentity}/Rules/{identity}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bookingTypeIdentity

string

Required

identity

string

Required

Body Parameters

BookingRule
NameDescriptionTypeAdditional 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.

AdminsExempt

boolean

None.

BookingManagersExempt

boolean

None.

ApproversExempt

boolean

None.

PermissionGroupsExempt

boolean

None.

ExemptPermissionGroups

Collection of NamedObject

None.

Request Formats

application/json, text/json

Sample:
{
  "Identity": "08844374-9d42-4c33-a786-95397d18f1e3",
  "RuleType": {
    "Properties": [
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "Identity": "7078d03d-7363-411a-836c-c824a185cd7a",
        "StartRange": true,
        "EndRange": true
      },
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "Identity": "7078d03d-7363-411a-836c-c824a185cd7a",
        "StartRange": true,
        "EndRange": true
      }
    ],
    "RunOnUpdateAsCreate": true,
    "RunOnCreateType": 0,
    "RunOnUpdateType": 0,
    "RunOnDeleteType": 0,
    "RuleGroupRequiresOneValidOnly": true,
    "Identity": "f6a8b234-77ca-4efe-b870-9b4c5283dcae",
    "Name": "sample string 4"
  },
  "Properties": [
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "StartRange": true,
      "EndRange": true,
      "IsObsolete": true,
      "Identity": "d36d2f5b-705d-4923-b453-7cb07d0bd3e6",
      "Name": "sample string 7"
    },
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "StartRange": true,
      "EndRange": true,
      "IsObsolete": true,
      "Identity": "d36d2f5b-705d-4923-b453-7cb07d0bd3e6",
      "Name": "sample string 7"
    }
  ],
  "AppliesTo": [
    {
      "Identity": "82126c81-09ba-4a2e-a951-4c63955ad8fc",
      "Name": "sample string 2"
    },
    {
      "Identity": "82126c81-09ba-4a2e-a951-4c63955ad8fc",
      "Name": "sample string 2"
    }
  ],
  "RunOnCreate": true,
  "RunOnUpdate": true,
  "RunOnDelete": true,
  "FailureMessage": "sample string 5",
  "AdminsExempt": true,
  "BookingManagersExempt": true,
  "ApproversExempt": true,
  "PermissionGroupsExempt": true,
  "ExemptPermissionGroups": [
    {
      "Identity": "82126c81-09ba-4a2e-a951-4c63955ad8fc",
      "Name": "sample string 2"
    },
    {
      "Identity": "82126c81-09ba-4a2e-a951-4c63955ad8fc",
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<BookingRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <AdminsExempt>true</AdminsExempt>
  <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>82126c81-09ba-4a2e-a951-4c63955ad8fc</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>82126c81-09ba-4a2e-a951-4c63955ad8fc</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </AppliesTo>
  <ApproversExempt>true</ApproversExempt>
  <BookingManagersExempt>true</BookingManagersExempt>
  <ExemptPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>82126c81-09ba-4a2e-a951-4c63955ad8fc</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>82126c81-09ba-4a2e-a951-4c63955ad8fc</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </ExemptPermissionGroups>
  <FailureMessage>sample string 5</FailureMessage>
  <Identity>08844374-9d42-4c33-a786-95397d18f1e3</Identity>
  <PermissionGroupsExempt>true</PermissionGroupsExempt>
  <Properties>
    <BookingRuleDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d36d2f5b-705d-4923-b453-7cb07d0bd3e6</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <EndRange>true</EndRange>
      <IsObsolete>true</IsObsolete>
      <StartRange>true</StartRange>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueType>sample string 2</ValueType>
    </BookingRuleDatum>
    <BookingRuleDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d36d2f5b-705d-4923-b453-7cb07d0bd3e6</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <EndRange>true</EndRange>
      <IsObsolete>true</IsObsolete>
      <StartRange>true</StartRange>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueType>sample string 2</ValueType>
    </BookingRuleDatum>
  </Properties>
  <RuleType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">f6a8b234-77ca-4efe-b870-9b4c5283dcae</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
    <Properties>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>7078d03d-7363-411a-836c-c824a185cd7a</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>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>7078d03d-7363-411a-836c-c824a185cd7a</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>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
    </Properties>
    <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly>
    <RunOnCreateType>Never</RunOnCreateType>
    <RunOnDeleteType>Never</RunOnDeleteType>
    <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
    <RunOnUpdateType>Never</RunOnUpdateType>
  </RuleType>
  <RunOnCreate>true</RunOnCreate>
  <RunOnDelete>true</RunOnDelete>
  <RunOnUpdate>true</RunOnUpdate>
</BookingRule>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BookingRule
NameDescriptionTypeAdditional 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.

AdminsExempt

boolean

None.

BookingManagersExempt

boolean

None.

ApproversExempt

boolean

None.

PermissionGroupsExempt

boolean

None.

ExemptPermissionGroups

Collection of NamedObject

None.

Response Formats

application/json, text/json

Sample:
{
  "Identity": "7dd82269-3032-4e0e-baa5-6f612f7e0f34",
  "RuleType": {
    "Properties": [
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "Identity": "3135e04b-5844-4cfc-bb20-f446534c4951",
        "StartRange": true,
        "EndRange": true
      },
      {
        "Name": "sample string 1",
        "ValueType": "sample string 2",
        "ValueChoices": [
          "sample string 1",
          "sample string 2"
        ],
        "Identity": "3135e04b-5844-4cfc-bb20-f446534c4951",
        "StartRange": true,
        "EndRange": true
      }
    ],
    "RunOnUpdateAsCreate": true,
    "RunOnCreateType": 0,
    "RunOnUpdateType": 0,
    "RunOnDeleteType": 0,
    "RuleGroupRequiresOneValidOnly": true,
    "Identity": "7e8c0fe3-e4c8-4fb2-98d8-e98fc6a35e5f",
    "Name": "sample string 4"
  },
  "Properties": [
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "StartRange": true,
      "EndRange": true,
      "IsObsolete": true,
      "Identity": "2439898f-1c41-4af5-82ec-3007b2b55fce",
      "Name": "sample string 7"
    },
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "StartRange": true,
      "EndRange": true,
      "IsObsolete": true,
      "Identity": "2439898f-1c41-4af5-82ec-3007b2b55fce",
      "Name": "sample string 7"
    }
  ],
  "AppliesTo": [
    {
      "Identity": "4673c0e0-2d6d-4e99-9560-39fbf87662c9",
      "Name": "sample string 2"
    },
    {
      "Identity": "4673c0e0-2d6d-4e99-9560-39fbf87662c9",
      "Name": "sample string 2"
    }
  ],
  "RunOnCreate": true,
  "RunOnUpdate": true,
  "RunOnDelete": true,
  "FailureMessage": "sample string 5",
  "AdminsExempt": true,
  "BookingManagersExempt": true,
  "ApproversExempt": true,
  "PermissionGroupsExempt": true,
  "ExemptPermissionGroups": [
    {
      "Identity": "4673c0e0-2d6d-4e99-9560-39fbf87662c9",
      "Name": "sample string 2"
    },
    {
      "Identity": "4673c0e0-2d6d-4e99-9560-39fbf87662c9",
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<BookingRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <AdminsExempt>true</AdminsExempt>
  <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>4673c0e0-2d6d-4e99-9560-39fbf87662c9</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>4673c0e0-2d6d-4e99-9560-39fbf87662c9</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </AppliesTo>
  <ApproversExempt>true</ApproversExempt>
  <BookingManagersExempt>true</BookingManagersExempt>
  <ExemptPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>4673c0e0-2d6d-4e99-9560-39fbf87662c9</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>4673c0e0-2d6d-4e99-9560-39fbf87662c9</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </ExemptPermissionGroups>
  <FailureMessage>sample string 5</FailureMessage>
  <Identity>7dd82269-3032-4e0e-baa5-6f612f7e0f34</Identity>
  <PermissionGroupsExempt>true</PermissionGroupsExempt>
  <Properties>
    <BookingRuleDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2439898f-1c41-4af5-82ec-3007b2b55fce</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <EndRange>true</EndRange>
      <IsObsolete>true</IsObsolete>
      <StartRange>true</StartRange>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueType>sample string 2</ValueType>
    </BookingRuleDatum>
    <BookingRuleDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2439898f-1c41-4af5-82ec-3007b2b55fce</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <EndRange>true</EndRange>
      <IsObsolete>true</IsObsolete>
      <StartRange>true</StartRange>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueType>sample string 2</ValueType>
    </BookingRuleDatum>
  </Properties>
  <RuleType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">7e8c0fe3-e4c8-4fb2-98d8-e98fc6a35e5f</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
    <Properties>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>3135e04b-5844-4cfc-bb20-f446534c4951</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>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
      <BookingRuleTypeProperty>
        <EndRange>true</EndRange>
        <Identity>3135e04b-5844-4cfc-bb20-f446534c4951</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>
        <ValueType>sample string 2</ValueType>
      </BookingRuleTypeProperty>
    </Properties>
    <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly>
    <RunOnCreateType>Never</RunOnCreateType>
    <RunOnDeleteType>Never</RunOnDeleteType>
    <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate>
    <RunOnUpdateType>Never</RunOnUpdateType>
  </RuleType>
  <RunOnCreate>true</RunOnCreate>
  <RunOnDelete>true</RunOnDelete>
  <RunOnUpdate>true</RunOnUpdate>
</BookingRule>