POST api/BookingTypes/{bookingTypeIdentity}/Rules
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| bookingTypeIdentity | string |
Required |
Body Parameters
BookingRule| Name | 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": "66c8dfbb-a48c-4a08-b7ce-d62322a080e9",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "f1b5a8e8-6434-4b46-9c8f-7478f3c69a02",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "f1b5a8e8-6434-4b46-9c8f-7478f3c69a02",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "e9d6dad3-fd0b-417c-a5ed-f3c1364e58b9",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "8f9e2f48-7472-4687-a91b-ab2492352f3f",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "8f9e2f48-7472-4687-a91b-ab2492352f3f",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "a35478c5-b2b4-4608-89dc-ca8b749862d6",
"Name": "sample string 2"
},
{
"Identity": "a35478c5-b2b4-4608-89dc-ca8b749862d6",
"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>a35478c5-b2b4-4608-89dc-ca8b749862d6</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>a35478c5-b2b4-4608-89dc-ca8b749862d6</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>66c8dfbb-a48c-4a08-b7ce-d62322a080e9</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">8f9e2f48-7472-4687-a91b-ab2492352f3f</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">8f9e2f48-7472-4687-a91b-ab2492352f3f</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">e9d6dad3-fd0b-417c-a5ed-f3c1364e58b9</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>f1b5a8e8-6434-4b46-9c8f-7478f3c69a02</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>f1b5a8e8-6434-4b46-9c8f-7478f3c69a02</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
BookingRule| Name | 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": "53b33577-0d9d-404d-ac52-b9ef7e050bf5",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "940825a8-d6bc-4662-8f6d-f4080c54ce78",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "940825a8-d6bc-4662-8f6d-f4080c54ce78",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "1e1f55d4-98a7-454f-9dca-3f80791df775",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "76b83b7c-9bd5-4b74-8264-1b1fe5bae348",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "76b83b7c-9bd5-4b74-8264-1b1fe5bae348",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "d4945374-36a7-4b81-ae6c-f45a0d993b6a",
"Name": "sample string 2"
},
{
"Identity": "d4945374-36a7-4b81-ae6c-f45a0d993b6a",
"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>d4945374-36a7-4b81-ae6c-f45a0d993b6a</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>d4945374-36a7-4b81-ae6c-f45a0d993b6a</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>53b33577-0d9d-404d-ac52-b9ef7e050bf5</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">76b83b7c-9bd5-4b74-8264-1b1fe5bae348</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">76b83b7c-9bd5-4b74-8264-1b1fe5bae348</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">1e1f55d4-98a7-454f-9dca-3f80791df775</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>940825a8-d6bc-4662-8f6d-f4080c54ce78</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>940825a8-d6bc-4662-8f6d-f4080c54ce78</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>