POST api/licenses

Returns all licenses in specific Account context based on provided filters

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FilterTargetIdentifier	string	None.
FilterInstitutionTypeId	string	None.
FilterInstitutionTypeName	string	None.
FilterIsbn	string	None.
FilterProductName	string	None.
FilterStartDate	string	None.
FilterEndDate	string	None.
FilterTargetName	string	None.
FilterLicenseType	string	None.
FilterLicenseTypeId	string	None.
FilterOwnerId	string	None.
FilterOwnerName	string	None.
FilterMunicipalityName	string	None.
FilterMunicipalityNumber	string	None.
FilterSubscriptionNumber	string	None.
FilterAccessType	string	None.
FilterAccessTypeId	string	None.
FilterImprintId	string	None.
FilterImprintName	string	None.
FilterProductGroupDictionaryId	string	None.
FilterProductGroupDictionaryName	string	None.
FilterTopicId	string	None.
FilterTopicName	string	None.
FilterProductTargetDictionaryId	string	None.
FilterProductTargetDictionary	string	None.
FilterLicenseCategory	string	None.
FilterLicenseCategoryId	string	None.
FilterOwnerTypeId	string	None.
FilterOwnerType	string	None.
FilterPaused	string	None.
SortOwnerName	string	None.
SortProductName	string	None.
SortIsbn	string	None.
SortStartDate	string	None.
SortEndDate	string	None.
SortMunicipalityName	string	None.
SortSubscriptionNumber	string	None.
SortTopicName	string	None.
SortAccessType	string	None.
SortLicenseType	string	None.
SortTargetIdentifier	string	None.
SortTargetName	string	None.
Filters	Dictionary of string [key] and FilterValue [value]	None.
SortFields	Dictionary of string [key] and OrderType [value]	None.
AvailablePageSizes	Collection of integer	None.
PageSize	integer	None.
PageIndex	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FilterTargetIdentifier": "TargetIdentifier",
  "FilterInstitutionTypeId": "InstitutionTypeId",
  "FilterInstitutionTypeName": "InstitutionTypeName",
  "FilterIsbn": "ProductIsbn",
  "FilterProductName": "ProductName",
  "FilterStartDate": "StartDate",
  "FilterEndDate": "EndDate",
  "FilterTargetName": "TargetName",
  "FilterLicenseType": "LicenseType",
  "FilterLicenseTypeId": "LicenseTypeId",
  "FilterOwnerId": "OwnerId",
  "FilterOwnerName": "OwnerName",
  "FilterMunicipalityName": "MunicipalityName",
  "FilterMunicipalityNumber": "MunicipalityNumber",
  "FilterSubscriptionNumber": "SubscriptionNumber",
  "FilterAccessType": "AccessType",
  "FilterAccessTypeId": "AccessTypeId",
  "FilterImprintId": "ImprintId",
  "FilterImprintName": "ImprintName",
  "FilterProductGroupDictionaryId": "ProductGroupDictionaryId",
  "FilterProductGroupDictionaryName": "ProductGroupDictionaryName",
  "FilterTopicId": "TopicId",
  "FilterTopicName": "TopicName",
  "FilterProductTargetDictionaryId": "TargetDictionaryId",
  "FilterProductTargetDictionary": "TargetDictionary",
  "FilterLicenseCategory": "LicenseCategory",
  "FilterLicenseCategoryId": "LicenseCategoryId",
  "FilterOwnerTypeId": "OwnerTypeId",
  "FilterOwnerType": "OwnerType",
  "FilterPaused": "Paused",
  "SortOwnerName": "OwnerName",
  "SortProductName": "ProductName",
  "SortIsbn": "Isbn",
  "SortStartDate": "StartDate",
  "SortEndDate": "EndDate",
  "SortMunicipalityName": "MunicipalityName",
  "SortSubscriptionNumber": "SubscriptionNumber",
  "SortTopicName": "TopicName",
  "SortAccessType": "AccessType",
  "SortLicenseType": "LicenseType",
  "SortTargetIdentifier": "TargetIdentifier",
  "SortTargetName": "TargetName",
  "Filters": {
    "sample string 1": {
      "Value": "sample string 1",
      "FilterType": 0
    },
    "sample string 2": {
      "Value": "sample string 1",
      "FilterType": 0
    }
  },
  "SortFields": {
    "sample string 1": 0,
    "sample string 2": 0
  },
  "AvailablePageSizes": [
    10,
    50,
    100
  ],
  "PageSize": 1,
  "PageIndex": 2
}

application/xml, text/xml

Sample:

<GetLicensesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
  <AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
    <d2p1:int>10</d2p1:int>
    <d2p1:int>50</d2p1:int>
    <d2p1:int>100</d2p1:int>
  </AvailablePageSizes>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">2</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">1</PageSize>
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
  </Filters>
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
  </SortFields>
</GetLicensesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiCollectionResponseOfIEnumerableOfGetAllLicenseResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Errors	Collection of string	None.
Data	Collection of GetAllLicenseResponse	None.
Filters	Dictionary of string [key] and FilterValue [value]	None.
SortFields	Dictionary of string [key] and OrderType [value]	None.
AvailablePageSizes	Collection of integer	None.
PageSize	integer	None.
PageIndex	integer	None.
Total	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "Id": "57addf2c-603d-4e4f-b383-f70c886ad1cb",
      "AccountId": "3f886336-57d6-4b93-bad5-ddb1a3a099b9",
      "Product": {
        "ProductId": "1d81c692-1760-4310-8500-e044e852e652",
        "ProductName": "sample string 2",
        "ProductIsbn": "sample string 3",
        "TopicDictionary": "sample string 4",
        "TopicDictionaryId": "e68e6c53-1de9-4f16-bea6-dcf393f215f0",
        "TargetDictionary": "sample string 5",
        "TargetDictionaryId": "0fa0871b-7f62-405e-a910-4732d38511ef",
        "ImprintDictionary": "sample string 6",
        "ImprintDictionaryId": "f78134a4-52e7-439b-a4a4-31b6409f1a0d",
        "ProductGroupDictionary": "sample string 7",
        "ProductGroupDictionaryId": "400bf608-5fe2-4c9b-a11f-e36703c1fa4a",
        "IsActive": true
      },
      "OwnerName": "sample string 3",
      "LicenseName": "sample string 4",
      "StartDate": "2025-12-25T15:47:39.1573869+00:00",
      "EndDate": "2025-12-25T15:47:39.1573869+00:00",
      "LicenseType": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "AccessType": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "Category": {
        "Key": "936188d4-8057-452a-bfc0-301c1c493107",
        "Value": "sample string 1"
      },
      "Grade": "sample string 5",
      "IsPaused": true,
      "MunicipalityName": "sample string 7",
      "SubscriptionNumber": "sample string 8",
      "TargetIdentifier": "sample string 9",
      "TargetName": "sample string 10"
    },
    {
      "Id": "57addf2c-603d-4e4f-b383-f70c886ad1cb",
      "AccountId": "3f886336-57d6-4b93-bad5-ddb1a3a099b9",
      "Product": {
        "ProductId": "1d81c692-1760-4310-8500-e044e852e652",
        "ProductName": "sample string 2",
        "ProductIsbn": "sample string 3",
        "TopicDictionary": "sample string 4",
        "TopicDictionaryId": "e68e6c53-1de9-4f16-bea6-dcf393f215f0",
        "TargetDictionary": "sample string 5",
        "TargetDictionaryId": "0fa0871b-7f62-405e-a910-4732d38511ef",
        "ImprintDictionary": "sample string 6",
        "ImprintDictionaryId": "f78134a4-52e7-439b-a4a4-31b6409f1a0d",
        "ProductGroupDictionary": "sample string 7",
        "ProductGroupDictionaryId": "400bf608-5fe2-4c9b-a11f-e36703c1fa4a",
        "IsActive": true
      },
      "OwnerName": "sample string 3",
      "LicenseName": "sample string 4",
      "StartDate": "2025-12-25T15:47:39.1573869+00:00",
      "EndDate": "2025-12-25T15:47:39.1573869+00:00",
      "LicenseType": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "AccessType": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "Category": {
        "Key": "936188d4-8057-452a-bfc0-301c1c493107",
        "Value": "sample string 1"
      },
      "Grade": "sample string 5",
      "IsPaused": true,
      "MunicipalityName": "sample string 7",
      "SubscriptionNumber": "sample string 8",
      "TargetIdentifier": "sample string 9",
      "TargetName": "sample string 10"
    }
  ],
  "Filters": {
    "sample string 1": {
      "Value": "sample string 1",
      "FilterType": 0
    },
    "sample string 2": {
      "Value": "sample string 1",
      "FilterType": 0
    }
  },
  "SortFields": {
    "sample string 1": 0,
    "sample string 2": 0
  },
  "AvailablePageSizes": [
    10,
    50,
    100
  ],
  "PageSize": 2,
  "PageIndex": 3,
  "Total": 4
}

application/xml, text/xml

Sample:

<ApiCollectionResponseOfArrayOfGetAllLicenseResponseWrTuDEXQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
  <AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>10</d2p1:int>
    <d2p1:int>50</d2p1:int>
    <d2p1:int>100</d2p1:int>
  </AvailablePageSizes>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses.Licenses">
    <d2p1:GetAllLicenseResponse>
      <d2p1:AccessType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </d2p1:AccessType>
      <d2p1:AccountId>3f886336-57d6-4b93-bad5-ddb1a3a099b9</d2p1:AccountId>
      <d2p1:Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>936188d4-8057-452a-bfc0-301c1c493107</d4p1:key>
        <d4p1:value>sample string 1</d4p1:value>
      </d2p1:Category>
      <d2p1:EndDate>2025-12-25T15:47:39.1573869+00:00</d2p1:EndDate>
      <d2p1:Grade>sample string 5</d2p1:Grade>
      <d2p1:Id>57addf2c-603d-4e4f-b383-f70c886ad1cb</d2p1:Id>
      <d2p1:IsPaused>true</d2p1:IsPaused>
      <d2p1:LicenseName>sample string 4</d2p1:LicenseName>
      <d2p1:LicenseType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </d2p1:LicenseType>
      <d2p1:MunicipalityName>sample string 7</d2p1:MunicipalityName>
      <d2p1:OwnerName>sample string 3</d2p1:OwnerName>
      <d2p1:Product>
        <d2p1:ImprintDictionary>sample string 6</d2p1:ImprintDictionary>
        <d2p1:ImprintDictionaryId>f78134a4-52e7-439b-a4a4-31b6409f1a0d</d2p1:ImprintDictionaryId>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ProductGroupDictionary>sample string 7</d2p1:ProductGroupDictionary>
        <d2p1:ProductGroupDictionaryId>400bf608-5fe2-4c9b-a11f-e36703c1fa4a</d2p1:ProductGroupDictionaryId>
        <d2p1:ProductId>1d81c692-1760-4310-8500-e044e852e652</d2p1:ProductId>
        <d2p1:ProductIsbn>sample string 3</d2p1:ProductIsbn>
        <d2p1:ProductName>sample string 2</d2p1:ProductName>
        <d2p1:TargetDictionary>sample string 5</d2p1:TargetDictionary>
        <d2p1:TargetDictionaryId>0fa0871b-7f62-405e-a910-4732d38511ef</d2p1:TargetDictionaryId>
        <d2p1:TopicDictionary>sample string 4</d2p1:TopicDictionary>
        <d2p1:TopicDictionaryId>e68e6c53-1de9-4f16-bea6-dcf393f215f0</d2p1:TopicDictionaryId>
      </d2p1:Product>
      <d2p1:StartDate>2025-12-25T15:47:39.1573869+00:00</d2p1:StartDate>
      <d2p1:SubscriptionNumber>sample string 8</d2p1:SubscriptionNumber>
      <d2p1:TargetIdentifier>sample string 9</d2p1:TargetIdentifier>
      <d2p1:TargetName>sample string 10</d2p1:TargetName>
    </d2p1:GetAllLicenseResponse>
    <d2p1:GetAllLicenseResponse>
      <d2p1:AccessType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </d2p1:AccessType>
      <d2p1:AccountId>3f886336-57d6-4b93-bad5-ddb1a3a099b9</d2p1:AccountId>
      <d2p1:Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>936188d4-8057-452a-bfc0-301c1c493107</d4p1:key>
        <d4p1:value>sample string 1</d4p1:value>
      </d2p1:Category>
      <d2p1:EndDate>2025-12-25T15:47:39.1573869+00:00</d2p1:EndDate>
      <d2p1:Grade>sample string 5</d2p1:Grade>
      <d2p1:Id>57addf2c-603d-4e4f-b383-f70c886ad1cb</d2p1:Id>
      <d2p1:IsPaused>true</d2p1:IsPaused>
      <d2p1:LicenseName>sample string 4</d2p1:LicenseName>
      <d2p1:LicenseType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </d2p1:LicenseType>
      <d2p1:MunicipalityName>sample string 7</d2p1:MunicipalityName>
      <d2p1:OwnerName>sample string 3</d2p1:OwnerName>
      <d2p1:Product>
        <d2p1:ImprintDictionary>sample string 6</d2p1:ImprintDictionary>
        <d2p1:ImprintDictionaryId>f78134a4-52e7-439b-a4a4-31b6409f1a0d</d2p1:ImprintDictionaryId>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ProductGroupDictionary>sample string 7</d2p1:ProductGroupDictionary>
        <d2p1:ProductGroupDictionaryId>400bf608-5fe2-4c9b-a11f-e36703c1fa4a</d2p1:ProductGroupDictionaryId>
        <d2p1:ProductId>1d81c692-1760-4310-8500-e044e852e652</d2p1:ProductId>
        <d2p1:ProductIsbn>sample string 3</d2p1:ProductIsbn>
        <d2p1:ProductName>sample string 2</d2p1:ProductName>
        <d2p1:TargetDictionary>sample string 5</d2p1:TargetDictionary>
        <d2p1:TargetDictionaryId>0fa0871b-7f62-405e-a910-4732d38511ef</d2p1:TargetDictionaryId>
        <d2p1:TopicDictionary>sample string 4</d2p1:TopicDictionary>
        <d2p1:TopicDictionaryId>e68e6c53-1de9-4f16-bea6-dcf393f215f0</d2p1:TopicDictionaryId>
      </d2p1:Product>
      <d2p1:StartDate>2025-12-25T15:47:39.1573869+00:00</d2p1:StartDate>
      <d2p1:SubscriptionNumber>sample string 8</d2p1:SubscriptionNumber>
      <d2p1:TargetIdentifier>sample string 9</d2p1:TargetIdentifier>
      <d2p1:TargetName>sample string 10</d2p1:TargetName>
    </d2p1:GetAllLicenseResponse>
  </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>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
  </Filters>
  <IsSuccess>true</IsSuccess>
  <PageIndex>3</PageIndex>
  <PageSize>2</PageSize>
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
  </SortFields>
  <Total>4</Total>
</ApiCollectionResponseOfArrayOfGetAllLicenseResponseWrTuDEXQ>