POST api/BookingTypes/{bookingTypeIdentity}/Rules
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bookingTypeIdentity | string |
Required |
Body Parameters
BookingRuleName | Description | 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. |
Request Formats
application/json, text/json
Sample:
{ "Identity": "cb90e988-2769-48ce-ab77-207d4f8bf67d", "RuleType": { "Properties": [ { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "5b935284-7295-4175-a163-2916da1906b6", "StartRange": true, "EndRange": true }, { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "5b935284-7295-4175-a163-2916da1906b6", "StartRange": true, "EndRange": true } ], "RunOnUpdateAsCreate": true, "RunOnCreateType": 0, "RunOnUpdateType": 0, "RunOnDeleteType": 0, "Identity": "4af3355e-4c27-4a27-8c0f-7367253af6ad", "Name": "sample string 3" }, "Properties": [ { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "Identity": "53dfc46b-cc84-4804-9be2-773607750303", "Name": "sample string 6" }, { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "Identity": "53dfc46b-cc84-4804-9be2-773607750303", "Name": "sample string 6" } ], "AppliesTo": [ { "Identity": "b6cf2169-0c4f-4d6a-b64a-00ed522f6db9", "Name": "sample string 2" }, { "Identity": "b6cf2169-0c4f-4d6a-b64a-00ed522f6db9", "Name": "sample string 2" } ], "RunOnCreate": true, "RunOnUpdate": true, "RunOnDelete": true, "FailureMessage": "sample string 5" }
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"> <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>b6cf2169-0c4f-4d6a-b64a-00ed522f6db9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>b6cf2169-0c4f-4d6a-b64a-00ed522f6db9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </AppliesTo> <FailureMessage>sample string 5</FailureMessage> <Identity>cb90e988-2769-48ce-ab77-207d4f8bf67d</Identity> <Properties> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">53dfc46b-cc84-4804-9be2-773607750303</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: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">53dfc46b-cc84-4804-9be2-773607750303</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: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">4af3355e-4c27-4a27-8c0f-7367253af6ad</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name> <Properties> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>5b935284-7295-4175-a163-2916da1906b6</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>5b935284-7295-4175-a163-2916da1906b6</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> <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
BookingRuleName | Description | 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": "d7eb66b7-502b-4990-83e1-d291ea2c9ca8", "RuleType": { "Properties": [ { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "0aca2411-457b-43fd-b4b1-8bac8fc003fa", "StartRange": true, "EndRange": true }, { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "0aca2411-457b-43fd-b4b1-8bac8fc003fa", "StartRange": true, "EndRange": true } ], "RunOnUpdateAsCreate": true, "RunOnCreateType": 0, "RunOnUpdateType": 0, "RunOnDeleteType": 0, "Identity": "b36fd9d8-f22d-487d-a8a1-695bd1808125", "Name": "sample string 3" }, "Properties": [ { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "Identity": "6d3c3a34-96de-44d5-8016-f97e1d939aea", "Name": "sample string 6" }, { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "Identity": "6d3c3a34-96de-44d5-8016-f97e1d939aea", "Name": "sample string 6" } ], "AppliesTo": [ { "Identity": "d0e200eb-fd7f-406d-bd1e-05a839db5b95", "Name": "sample string 2" }, { "Identity": "d0e200eb-fd7f-406d-bd1e-05a839db5b95", "Name": "sample string 2" } ], "RunOnCreate": true, "RunOnUpdate": true, "RunOnDelete": true, "FailureMessage": "sample string 5" }
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"> <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>d0e200eb-fd7f-406d-bd1e-05a839db5b95</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>d0e200eb-fd7f-406d-bd1e-05a839db5b95</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </AppliesTo> <FailureMessage>sample string 5</FailureMessage> <Identity>d7eb66b7-502b-4990-83e1-d291ea2c9ca8</Identity> <Properties> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">6d3c3a34-96de-44d5-8016-f97e1d939aea</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: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">6d3c3a34-96de-44d5-8016-f97e1d939aea</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: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">b36fd9d8-f22d-487d-a8a1-695bd1808125</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name> <Properties> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>0aca2411-457b-43fd-b4b1-8bac8fc003fa</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>0aca2411-457b-43fd-b4b1-8bac8fc003fa</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> <RunOnCreateType>Never</RunOnCreateType> <RunOnDeleteType>Never</RunOnDeleteType> <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate> <RunOnUpdateType>Never</RunOnUpdateType> </RuleType> <RunOnCreate>true</RunOnCreate> <RunOnDelete>true</RunOnDelete> <RunOnUpdate>true</RunOnUpdate> </BookingRule>