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": "afe422a6-68ef-44d5-9044-4fefbbf08b98",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "2867a586-94f6-4a5d-bce3-0aa073b42e75",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "2867a586-94f6-4a5d-bce3-0aa073b42e75",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "632065ad-89a8-4ba8-911d-0deb0513e38d",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "3f963826-5569-4ccf-8eb2-b1e90735984c",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "3f963826-5569-4ccf-8eb2-b1e90735984c",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "03affa20-96b9-4e0b-96dc-9dcc778bb873",
"Name": "sample string 2"
},
{
"Identity": "03affa20-96b9-4e0b-96dc-9dcc778bb873",
"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>03affa20-96b9-4e0b-96dc-9dcc778bb873</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>03affa20-96b9-4e0b-96dc-9dcc778bb873</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>afe422a6-68ef-44d5-9044-4fefbbf08b98</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">3f963826-5569-4ccf-8eb2-b1e90735984c</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">3f963826-5569-4ccf-8eb2-b1e90735984c</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">632065ad-89a8-4ba8-911d-0deb0513e38d</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>2867a586-94f6-4a5d-bce3-0aa073b42e75</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>2867a586-94f6-4a5d-bce3-0aa073b42e75</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": "9033253e-4028-48ab-be49-8b9942e5f91e",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "dbdb2f18-70c0-49e4-b64e-a4befe9f70bb",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "dbdb2f18-70c0-49e4-b64e-a4befe9f70bb",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "3ee1734e-3ada-4dd4-a777-b9389fee0e45",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "394c0cf5-b634-45f7-8f2f-a11b03511a15",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "394c0cf5-b634-45f7-8f2f-a11b03511a15",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "aeba1264-82ca-4ec2-966e-dc536c2be481",
"Name": "sample string 2"
},
{
"Identity": "aeba1264-82ca-4ec2-966e-dc536c2be481",
"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>aeba1264-82ca-4ec2-966e-dc536c2be481</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>aeba1264-82ca-4ec2-966e-dc536c2be481</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>9033253e-4028-48ab-be49-8b9942e5f91e</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">394c0cf5-b634-45f7-8f2f-a11b03511a15</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">394c0cf5-b634-45f7-8f2f-a11b03511a15</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">3ee1734e-3ada-4dd4-a777-b9389fee0e45</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>dbdb2f18-70c0-49e4-b64e-a4befe9f70bb</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>dbdb2f18-70c0-49e4-b64e-a4befe9f70bb</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>