POST api/presets
Get all presets
Request Information
URI Parameters
None.
Body Parameters
GetPresetsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| KnownSearchFields | Collection of string |
None. |
|
| KnownSortFields | Collection of string |
None. |
|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
|
| SearchBy | Collection of Filter |
None. |
|
| SortBy | Collection of Sort |
None. |
Request Formats
application/json, text/json
Sample:
{
"KnownSearchFields": [
"Name",
"SystemName",
"Buffer",
"AccessType",
"LicenseType",
"Category.Name"
],
"KnownSortFields": [
"Name",
"SystemName",
"Buffer",
"AccessType",
"LicenseType",
"Category.Name"
],
"PageSize": 1,
"PageIndex": 2,
"SearchBy": [
{
"Key": "sample string 1",
"Value": {},
"Type": 0
},
{
"Key": "sample string 1",
"Value": {},
"Type": 0
}
],
"SortBy": [
{
"Key": "sample string 1",
"Order": 0
},
{
"Key": "sample string 1",
"Order": 0
}
]
}
application/xml, text/xml
Sample:
<GetPresetsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
<KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
<d2p1:string>Name</d2p1:string>
<d2p1:string>SystemName</d2p1:string>
<d2p1:string>Buffer</d2p1:string>
<d2p1:string>AccessType</d2p1:string>
<d2p1:string>LicenseType</d2p1:string>
<d2p1:string>Category.Name</d2p1:string>
</KnownSearchFields>
<KnownSortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
<d2p1:string>Name</d2p1:string>
<d2p1:string>SystemName</d2p1:string>
<d2p1:string>Buffer</d2p1:string>
<d2p1:string>AccessType</d2p1:string>
<d2p1:string>LicenseType</d2p1:string>
<d2p1:string>Category.Name</d2p1:string>
</KnownSortFields>
<PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">2</PageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">1</PageSize>
<SearchBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
<Filter>
<Key>sample string 1</Key>
<Type>None</Type>
<Value />
</Filter>
<Filter>
<Key>sample string 1</Key>
<Type>None</Type>
<Value />
</Filter>
</SearchBy>
<SortBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
<Sort>
<Key>sample string 1</Key>
<Order>None</Order>
</Sort>
<Sort>
<Key>sample string 1</Key>
<Order>None</Order>
</Sort>
</SortBy>
</GetPresetsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of categories.
ApiCollectionResponseOfGetLicensePreSetResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
|
| Total | integer |
None. |
|
| SearchBy | Collection of Filter |
None. |
|
| SortBy | Collection of Sort |
None. |
|
| Data | Collection of GetLicensePreSetResponse |
None. |
|
| Errors | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PageSize": 1,
"PageIndex": 2,
"Total": 3,
"SearchBy": [
{
"Key": "sample string 1",
"Value": {},
"Type": 0
},
{
"Key": "sample string 1",
"Value": {},
"Type": 0
}
],
"SortBy": [
{
"Key": "sample string 1",
"Order": 0
},
{
"Key": "sample string 1",
"Order": 0
}
],
"Data": [
{
"Id": "1beb93c8-983c-44b2-b0a5-de2cc9c99027",
"Name": "sample string 2",
"SystemName": "sample string 3",
"Description": "sample string 4",
"Buffer": 1,
"LicenseType": 1,
"AccessType": 1,
"Category": "eae687c2-fa05-4106-a49e-3452ba49f1b6",
"Roles": [
"3567344e-58d2-4304-b54e-39e9b8aa0a40",
"b5531ada-bb04-420e-b625-5dd0a6bab7a4"
],
"Rules": [
{
"Id": "6b531390-4807-4704-a07d-41d37b3667b0",
"PreSetRuleType": 2,
"PreSetRuleValue": "sample string 3"
},
{
"Id": "6b531390-4807-4704-a07d-41d37b3667b0",
"PreSetRuleType": 2,
"PreSetRuleValue": "sample string 3"
}
],
"LicenseDurationModifierDto": {
"Years": 1,
"Months": 2,
"Weeks": 3,
"Days": 4
}
},
{
"Id": "1beb93c8-983c-44b2-b0a5-de2cc9c99027",
"Name": "sample string 2",
"SystemName": "sample string 3",
"Description": "sample string 4",
"Buffer": 1,
"LicenseType": 1,
"AccessType": 1,
"Category": "eae687c2-fa05-4106-a49e-3452ba49f1b6",
"Roles": [
"3567344e-58d2-4304-b54e-39e9b8aa0a40",
"b5531ada-bb04-420e-b625-5dd0a6bab7a4"
],
"Rules": [
{
"Id": "6b531390-4807-4704-a07d-41d37b3667b0",
"PreSetRuleType": 2,
"PreSetRuleValue": "sample string 3"
},
{
"Id": "6b531390-4807-4704-a07d-41d37b3667b0",
"PreSetRuleType": 2,
"PreSetRuleValue": "sample string 3"
}
],
"LicenseDurationModifierDto": {
"Years": 1,
"Months": 2,
"Weeks": 3,
"Days": 4
}
}
],
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ApiCollectionResponseOfGetLicensePreSetResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
<d2p1:GetLicensePreSetResponse>
<d2p1:AccessType>1</d2p1:AccessType>
<d2p1:Buffer>1</d2p1:Buffer>
<d2p1:Category>eae687c2-fa05-4106-a49e-3452ba49f1b6</d2p1:Category>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:Id>1beb93c8-983c-44b2-b0a5-de2cc9c99027</d2p1:Id>
<d2p1:LicenseDurationModifierDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
<d4p1:Days>4</d4p1:Days>
<d4p1:Months>2</d4p1:Months>
<d4p1:Weeks>3</d4p1:Weeks>
<d4p1:Years>1</d4p1:Years>
</d2p1:LicenseDurationModifierDto>
<d2p1:LicenseType>1</d2p1:LicenseType>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>3567344e-58d2-4304-b54e-39e9b8aa0a40</d4p1:guid>
<d4p1:guid>b5531ada-bb04-420e-b625-5dd0a6bab7a4</d4p1:guid>
</d2p1:Roles>
<d2p1:Rules xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
<d4p1:PreSetRuleDto>
<d4p1:Id>6b531390-4807-4704-a07d-41d37b3667b0</d4p1:Id>
<d4p1:PreSetRuleType>2</d4p1:PreSetRuleType>
<d4p1:PreSetRuleValue>sample string 3</d4p1:PreSetRuleValue>
</d4p1:PreSetRuleDto>
<d4p1:PreSetRuleDto>
<d4p1:Id>6b531390-4807-4704-a07d-41d37b3667b0</d4p1:Id>
<d4p1:PreSetRuleType>2</d4p1:PreSetRuleType>
<d4p1:PreSetRuleValue>sample string 3</d4p1:PreSetRuleValue>
</d4p1:PreSetRuleDto>
</d2p1:Rules>
<d2p1:SystemName>sample string 3</d2p1:SystemName>
</d2p1:GetLicensePreSetResponse>
<d2p1:GetLicensePreSetResponse>
<d2p1:AccessType>1</d2p1:AccessType>
<d2p1:Buffer>1</d2p1:Buffer>
<d2p1:Category>eae687c2-fa05-4106-a49e-3452ba49f1b6</d2p1:Category>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:Id>1beb93c8-983c-44b2-b0a5-de2cc9c99027</d2p1:Id>
<d2p1:LicenseDurationModifierDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
<d4p1:Days>4</d4p1:Days>
<d4p1:Months>2</d4p1:Months>
<d4p1:Weeks>3</d4p1:Weeks>
<d4p1:Years>1</d4p1:Years>
</d2p1:LicenseDurationModifierDto>
<d2p1:LicenseType>1</d2p1:LicenseType>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>3567344e-58d2-4304-b54e-39e9b8aa0a40</d4p1:guid>
<d4p1:guid>b5531ada-bb04-420e-b625-5dd0a6bab7a4</d4p1:guid>
</d2p1:Roles>
<d2p1:Rules xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
<d4p1:PreSetRuleDto>
<d4p1:Id>6b531390-4807-4704-a07d-41d37b3667b0</d4p1:Id>
<d4p1:PreSetRuleType>2</d4p1:PreSetRuleType>
<d4p1:PreSetRuleValue>sample string 3</d4p1:PreSetRuleValue>
</d4p1:PreSetRuleDto>
<d4p1:PreSetRuleDto>
<d4p1:Id>6b531390-4807-4704-a07d-41d37b3667b0</d4p1:Id>
<d4p1:PreSetRuleType>2</d4p1:PreSetRuleType>
<d4p1:PreSetRuleValue>sample string 3</d4p1:PreSetRuleValue>
</d4p1:PreSetRuleDto>
</d2p1:Rules>
<d2p1:SystemName>sample string 3</d2p1:SystemName>
</d2p1:GetLicensePreSetResponse>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<PageIndex>2</PageIndex>
<PageSize>1</PageSize>
<SearchBy>
<Filter>
<Key>sample string 1</Key>
<Type>None</Type>
<Value />
</Filter>
<Filter>
<Key>sample string 1</Key>
<Type>None</Type>
<Value />
</Filter>
</SearchBy>
<SortBy>
<Sort>
<Key>sample string 1</Key>
<Order>None</Order>
</Sort>
<Sort>
<Key>sample string 1</Key>
<Order>None</Order>
</Sort>
</SortBy>
<Total>3</Total>
</ApiCollectionResponseOfGetLicensePreSetResponseLgVmlFmJ>