POST api/ResourceTypes
Request Information
URI Parameters
None.
Body Parameters
ResourceTypeName | Description | Type | Additional information |
---|---|---|---|
Properties | Collection of ResourceProperty |
None. |
|
ImageUri | URI |
None. |
|
CanEdit | boolean |
None. |
|
HasAssociatedBookingTypes | boolean |
None. |
|
ReadPermissionGroups | Collection of NamedObject |
None. |
|
WritePermissionGroups | Collection of NamedObject |
None. |
|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Properties": [ { "ValueType": "sample string 1", "ValueChoices": [ "sample string 1", "sample string 2" ], "Rank": 2, "IsFilterable": true, "DisplayName": "sample string 4", "HelpText": "sample string 5", "Identity": "5368d4a4-8034-4d42-ab46-baf53f53b4f6", "Name": "sample string 7" }, { "ValueType": "sample string 1", "ValueChoices": [ "sample string 1", "sample string 2" ], "Rank": 2, "IsFilterable": true, "DisplayName": "sample string 4", "HelpText": "sample string 5", "Identity": "5368d4a4-8034-4d42-ab46-baf53f53b4f6", "Name": "sample string 7" } ], "ImageUri": "http://webapihelppage1.com", "CanEdit": true, "HasAssociatedBookingTypes": true, "ReadPermissionGroups": [ { "Identity": "b2bd74d6-cebf-4c72-8140-e5e076047d39", "Name": "sample string 2" }, { "Identity": "b2bd74d6-cebf-4c72-8140-e5e076047d39", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "b2bd74d6-cebf-4c72-8140-e5e076047d39", "Name": "sample string 2" }, { "Identity": "b2bd74d6-cebf-4c72-8140-e5e076047d39", "Name": "sample string 2" } ], "Identity": "7ae29323-1706-4e3b-921e-3cc869d31a54", "Name": "sample string 5" }
application/xml, text/xml
Sample:
<ResourceType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">7ae29323-1706-4e3b-921e-3cc869d31a54</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name> <ReadPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>b2bd74d6-cebf-4c72-8140-e5e076047d39</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>b2bd74d6-cebf-4c72-8140-e5e076047d39</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ReadPermissionGroups> <WritePermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>b2bd74d6-cebf-4c72-8140-e5e076047d39</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>b2bd74d6-cebf-4c72-8140-e5e076047d39</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </WritePermissionGroups> <CanEdit>true</CanEdit> <HasAssociatedBookingTypes>true</HasAssociatedBookingTypes> <ImageUri>http://webapihelppage1.com/</ImageUri> <Properties> <ResourceProperty> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5368d4a4-8034-4d42-ab46-baf53f53b4f6</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <DisplayName>sample string 4</DisplayName> <HelpText>sample string 5</HelpText> <IsFilterable>true</IsFilterable> <Rank>2</Rank> <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 1</ValueType> </ResourceProperty> <ResourceProperty> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5368d4a4-8034-4d42-ab46-baf53f53b4f6</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <DisplayName>sample string 4</DisplayName> <HelpText>sample string 5</HelpText> <IsFilterable>true</IsFilterable> <Rank>2</Rank> <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 1</ValueType> </ResourceProperty> </Properties> </ResourceType>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResourceTypeName | Description | Type | Additional information |
---|---|---|---|
Properties | Collection of ResourceProperty |
None. |
|
ImageUri | URI |
None. |
|
CanEdit | boolean |
None. |
|
HasAssociatedBookingTypes | boolean |
None. |
|
ReadPermissionGroups | Collection of NamedObject |
None. |
|
WritePermissionGroups | Collection of NamedObject |
None. |
|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Properties": [ { "ValueType": "sample string 1", "ValueChoices": [ "sample string 1", "sample string 2" ], "Rank": 2, "IsFilterable": true, "DisplayName": "sample string 4", "HelpText": "sample string 5", "Identity": "0e71b183-6504-4434-ab2b-70274fb4c88f", "Name": "sample string 7" }, { "ValueType": "sample string 1", "ValueChoices": [ "sample string 1", "sample string 2" ], "Rank": 2, "IsFilterable": true, "DisplayName": "sample string 4", "HelpText": "sample string 5", "Identity": "0e71b183-6504-4434-ab2b-70274fb4c88f", "Name": "sample string 7" } ], "ImageUri": "http://webapihelppage1.com", "CanEdit": true, "HasAssociatedBookingTypes": true, "ReadPermissionGroups": [ { "Identity": "0e54be16-b9a3-4bbe-ab40-b36c573f3ae9", "Name": "sample string 2" }, { "Identity": "0e54be16-b9a3-4bbe-ab40-b36c573f3ae9", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "0e54be16-b9a3-4bbe-ab40-b36c573f3ae9", "Name": "sample string 2" }, { "Identity": "0e54be16-b9a3-4bbe-ab40-b36c573f3ae9", "Name": "sample string 2" } ], "Identity": "a4aba5e7-a1bd-48e1-95d4-dd896cc9edb2", "Name": "sample string 5" }
application/xml, text/xml
Sample:
<ResourceType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">a4aba5e7-a1bd-48e1-95d4-dd896cc9edb2</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name> <ReadPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>0e54be16-b9a3-4bbe-ab40-b36c573f3ae9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>0e54be16-b9a3-4bbe-ab40-b36c573f3ae9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ReadPermissionGroups> <WritePermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>0e54be16-b9a3-4bbe-ab40-b36c573f3ae9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>0e54be16-b9a3-4bbe-ab40-b36c573f3ae9</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </WritePermissionGroups> <CanEdit>true</CanEdit> <HasAssociatedBookingTypes>true</HasAssociatedBookingTypes> <ImageUri>http://webapihelppage1.com/</ImageUri> <Properties> <ResourceProperty> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">0e71b183-6504-4434-ab2b-70274fb4c88f</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <DisplayName>sample string 4</DisplayName> <HelpText>sample string 5</HelpText> <IsFilterable>true</IsFilterable> <Rank>2</Rank> <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 1</ValueType> </ResourceProperty> <ResourceProperty> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">0e71b183-6504-4434-ab2b-70274fb4c88f</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <DisplayName>sample string 4</DisplayName> <HelpText>sample string 5</HelpText> <IsFilterable>true</IsFilterable> <Rank>2</Rank> <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 1</ValueType> </ResourceProperty> </Properties> </ResourceType>