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": "c631103d-eb6f-46ef-8136-4a919284eaba",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "8a271ac1-1bec-4189-b92e-ee68fec864da",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "8a271ac1-1bec-4189-b92e-ee68fec864da",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "82fad54c-6bee-4d25-b494-dc3974bab8e8",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "7e96ad84-270d-4155-9048-3873f349c4eb",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "7e96ad84-270d-4155-9048-3873f349c4eb",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "3e3d0d33-914d-4437-a8e4-8bad988c4f3b",
"Name": "sample string 2"
},
{
"Identity": "3e3d0d33-914d-4437-a8e4-8bad988c4f3b",
"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>3e3d0d33-914d-4437-a8e4-8bad988c4f3b</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>3e3d0d33-914d-4437-a8e4-8bad988c4f3b</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>c631103d-eb6f-46ef-8136-4a919284eaba</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">7e96ad84-270d-4155-9048-3873f349c4eb</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">7e96ad84-270d-4155-9048-3873f349c4eb</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">82fad54c-6bee-4d25-b494-dc3974bab8e8</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>8a271ac1-1bec-4189-b92e-ee68fec864da</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>8a271ac1-1bec-4189-b92e-ee68fec864da</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": "0c542200-074d-4327-a8be-121fd6d53184",
"RuleType": {
"Properties": [
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "b4673926-2cec-4215-8bb1-f7fc0317d42b",
"StartRange": true,
"EndRange": true
},
{
"Name": "sample string 1",
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"Identity": "b4673926-2cec-4215-8bb1-f7fc0317d42b",
"StartRange": true,
"EndRange": true
}
],
"RunOnUpdateAsCreate": true,
"RunOnCreateType": 0,
"RunOnUpdateType": 0,
"RunOnDeleteType": 0,
"Identity": "2e8dc478-54da-48f0-bad4-19b7b8656790",
"Name": "sample string 3"
},
"Properties": [
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "2663efea-c459-4b3d-b47b-124bf08ed2a1",
"Name": "sample string 6"
},
{
"Value": {},
"ValueType": "sample string 2",
"ValueChoices": [
"sample string 1",
"sample string 2"
],
"StartRange": true,
"EndRange": true,
"Identity": "2663efea-c459-4b3d-b47b-124bf08ed2a1",
"Name": "sample string 6"
}
],
"AppliesTo": [
{
"Identity": "37875ebf-324a-45a9-be74-d8a011c552a7",
"Name": "sample string 2"
},
{
"Identity": "37875ebf-324a-45a9-be74-d8a011c552a7",
"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>37875ebf-324a-45a9-be74-d8a011c552a7</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
<d2p1:NamedObject>
<d2p1:Identity>37875ebf-324a-45a9-be74-d8a011c552a7</d2p1:Identity>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:NamedObject>
</AppliesTo>
<FailureMessage>sample string 5</FailureMessage>
<Identity>0c542200-074d-4327-a8be-121fd6d53184</Identity>
<Properties>
<BookingRuleDatum>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2663efea-c459-4b3d-b47b-124bf08ed2a1</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">2663efea-c459-4b3d-b47b-124bf08ed2a1</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">2e8dc478-54da-48f0-bad4-19b7b8656790</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<Properties>
<BookingRuleTypeProperty>
<EndRange>true</EndRange>
<Identity>b4673926-2cec-4215-8bb1-f7fc0317d42b</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>b4673926-2cec-4215-8bb1-f7fc0317d42b</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>