POST api/user/{id}/products

Returns products that user has access to

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id of user	globally unique identifier	Required

Body Parameters

GetUserProductsRequest

Name	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": [
    "Isbn",
    "ProductAccessStartDate",
    "ProductAccessEndDate"
  ],
  "KnownSortFields": [
    "Isbn",
    "ProductAccessStartDate",
    "ProductAccessEndDate"
  ],
  "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:

<GetUserProductsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.User">
  <KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>Isbn</d2p1:string>
    <d2p1:string>ProductAccessStartDate</d2p1:string>
    <d2p1:string>ProductAccessEndDate</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>Isbn</d2p1:string>
    <d2p1:string>ProductAccessStartDate</d2p1:string>
    <d2p1:string>ProductAccessEndDate</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>
</GetUserProductsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiCollectionResponseOfIEnumerableOfGetLicensedProductDetailedResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Errors	Collection of string	None.
Data	Collection of GetLicensedProductDetailedResponse	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": [
    {
      "ProductName": "sample string 1",
      "Isbn": "sample string 2",
      "ProductAccessStartDate": "2025-12-25T15:50:15.2440213+00:00",
      "ProductAccessEndDate": "2025-12-25T15:50:15.2440213+00:00",
      "Licenses": [
        {
          "Id": "a17222f7-3447-4242-8e6d-3263f698fb49",
          "StartDate": "2025-12-25T15:50:15.2440213+00:00",
          "EndDate": "2025-12-25T15:50:15.2440213+00:00",
          "LicenseTypeId": 2,
          "LicenseTypeName": "sample string 3",
          "LicenseCategoryId": "a472aaef-f26e-4e8c-bc99-0c418ca6239f",
          "LicenseCategoryName": "sample string 4",
          "LicenseCategoryTypeId": 1,
          "LicenseCategoryTypeName": "sample string 5",
          "UserRoles": [
            "sample string 1",
            "sample string 2"
          ],
          "AgreementStartDate": "2025-12-25T15:50:15.2440213+00:00",
          "AgreementEndDate": "2025-12-25T15:50:15.2440213+00:00",
          "AvailableSeats": 1,
          "TakenSeats": 1,
          "TargetUserGroupTypeName": "sample string 6"
        },
        {
          "Id": "a17222f7-3447-4242-8e6d-3263f698fb49",
          "StartDate": "2025-12-25T15:50:15.2440213+00:00",
          "EndDate": "2025-12-25T15:50:15.2440213+00:00",
          "LicenseTypeId": 2,
          "LicenseTypeName": "sample string 3",
          "LicenseCategoryId": "a472aaef-f26e-4e8c-bc99-0c418ca6239f",
          "LicenseCategoryName": "sample string 4",
          "LicenseCategoryTypeId": 1,
          "LicenseCategoryTypeName": "sample string 5",
          "UserRoles": [
            "sample string 1",
            "sample string 2"
          ],
          "AgreementStartDate": "2025-12-25T15:50:15.2440213+00:00",
          "AgreementEndDate": "2025-12-25T15:50:15.2440213+00:00",
          "AvailableSeats": 1,
          "TakenSeats": 1,
          "TargetUserGroupTypeName": "sample string 6"
        }
      ]
    },
    {
      "ProductName": "sample string 1",
      "Isbn": "sample string 2",
      "ProductAccessStartDate": "2025-12-25T15:50:15.2440213+00:00",
      "ProductAccessEndDate": "2025-12-25T15:50:15.2440213+00:00",
      "Licenses": [
        {
          "Id": "a17222f7-3447-4242-8e6d-3263f698fb49",
          "StartDate": "2025-12-25T15:50:15.2440213+00:00",
          "EndDate": "2025-12-25T15:50:15.2440213+00:00",
          "LicenseTypeId": 2,
          "LicenseTypeName": "sample string 3",
          "LicenseCategoryId": "a472aaef-f26e-4e8c-bc99-0c418ca6239f",
          "LicenseCategoryName": "sample string 4",
          "LicenseCategoryTypeId": 1,
          "LicenseCategoryTypeName": "sample string 5",
          "UserRoles": [
            "sample string 1",
            "sample string 2"
          ],
          "AgreementStartDate": "2025-12-25T15:50:15.2440213+00:00",
          "AgreementEndDate": "2025-12-25T15:50:15.2440213+00:00",
          "AvailableSeats": 1,
          "TakenSeats": 1,
          "TargetUserGroupTypeName": "sample string 6"
        },
        {
          "Id": "a17222f7-3447-4242-8e6d-3263f698fb49",
          "StartDate": "2025-12-25T15:50:15.2440213+00:00",
          "EndDate": "2025-12-25T15:50:15.2440213+00:00",
          "LicenseTypeId": 2,
          "LicenseTypeName": "sample string 3",
          "LicenseCategoryId": "a472aaef-f26e-4e8c-bc99-0c418ca6239f",
          "LicenseCategoryName": "sample string 4",
          "LicenseCategoryTypeId": 1,
          "LicenseCategoryTypeName": "sample string 5",
          "UserRoles": [
            "sample string 1",
            "sample string 2"
          ],
          "AgreementStartDate": "2025-12-25T15:50:15.2440213+00:00",
          "AgreementEndDate": "2025-12-25T15:50:15.2440213+00:00",
          "AvailableSeats": 1,
          "TakenSeats": 1,
          "TargetUserGroupTypeName": "sample string 6"
        }
      ]
    }
  ],
  "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:

<ApiCollectionResponseOfArrayOfGetLicensedProductDetailedResponseCOpN3Co1 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.Product">
    <d2p1:GetLicensedProductDetailedResponse>
      <d2p1:Isbn>sample string 2</d2p1:Isbn>
      <d2p1:Licenses xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
        <d4p1:ProductLicenseDto>
          <d4p1:AgreementEndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementEndDate>
          <d4p1:AgreementStartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementStartDate>
          <d4p1:AvailableSeats>1</d4p1:AvailableSeats>
          <d4p1:EndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:EndDate>
          <d4p1:Id>a17222f7-3447-4242-8e6d-3263f698fb49</d4p1:Id>
          <d4p1:LicenseCategoryId>a472aaef-f26e-4e8c-bc99-0c418ca6239f</d4p1:LicenseCategoryId>
          <d4p1:LicenseCategoryName>sample string 4</d4p1:LicenseCategoryName>
          <d4p1:LicenseCategoryTypeId>1</d4p1:LicenseCategoryTypeId>
          <d4p1:LicenseCategoryTypeName>sample string 5</d4p1:LicenseCategoryTypeName>
          <d4p1:LicenseTypeId>2</d4p1:LicenseTypeId>
          <d4p1:LicenseTypeName>sample string 3</d4p1:LicenseTypeName>
          <d4p1:StartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:StartDate>
          <d4p1:TakenSeats>1</d4p1:TakenSeats>
          <d4p1:TargetUserGroupTypeName>sample string 6</d4p1:TargetUserGroupTypeName>
          <d4p1:UserRoles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:UserRoles>
        </d4p1:ProductLicenseDto>
        <d4p1:ProductLicenseDto>
          <d4p1:AgreementEndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementEndDate>
          <d4p1:AgreementStartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementStartDate>
          <d4p1:AvailableSeats>1</d4p1:AvailableSeats>
          <d4p1:EndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:EndDate>
          <d4p1:Id>a17222f7-3447-4242-8e6d-3263f698fb49</d4p1:Id>
          <d4p1:LicenseCategoryId>a472aaef-f26e-4e8c-bc99-0c418ca6239f</d4p1:LicenseCategoryId>
          <d4p1:LicenseCategoryName>sample string 4</d4p1:LicenseCategoryName>
          <d4p1:LicenseCategoryTypeId>1</d4p1:LicenseCategoryTypeId>
          <d4p1:LicenseCategoryTypeName>sample string 5</d4p1:LicenseCategoryTypeName>
          <d4p1:LicenseTypeId>2</d4p1:LicenseTypeId>
          <d4p1:LicenseTypeName>sample string 3</d4p1:LicenseTypeName>
          <d4p1:StartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:StartDate>
          <d4p1:TakenSeats>1</d4p1:TakenSeats>
          <d4p1:TargetUserGroupTypeName>sample string 6</d4p1:TargetUserGroupTypeName>
          <d4p1:UserRoles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:UserRoles>
        </d4p1:ProductLicenseDto>
      </d2p1:Licenses>
      <d2p1:ProductAccessEndDate>2025-12-25T15:50:15.2440213+00:00</d2p1:ProductAccessEndDate>
      <d2p1:ProductAccessStartDate>2025-12-25T15:50:15.2440213+00:00</d2p1:ProductAccessStartDate>
      <d2p1:ProductName>sample string 1</d2p1:ProductName>
    </d2p1:GetLicensedProductDetailedResponse>
    <d2p1:GetLicensedProductDetailedResponse>
      <d2p1:Isbn>sample string 2</d2p1:Isbn>
      <d2p1:Licenses xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
        <d4p1:ProductLicenseDto>
          <d4p1:AgreementEndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementEndDate>
          <d4p1:AgreementStartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementStartDate>
          <d4p1:AvailableSeats>1</d4p1:AvailableSeats>
          <d4p1:EndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:EndDate>
          <d4p1:Id>a17222f7-3447-4242-8e6d-3263f698fb49</d4p1:Id>
          <d4p1:LicenseCategoryId>a472aaef-f26e-4e8c-bc99-0c418ca6239f</d4p1:LicenseCategoryId>
          <d4p1:LicenseCategoryName>sample string 4</d4p1:LicenseCategoryName>
          <d4p1:LicenseCategoryTypeId>1</d4p1:LicenseCategoryTypeId>
          <d4p1:LicenseCategoryTypeName>sample string 5</d4p1:LicenseCategoryTypeName>
          <d4p1:LicenseTypeId>2</d4p1:LicenseTypeId>
          <d4p1:LicenseTypeName>sample string 3</d4p1:LicenseTypeName>
          <d4p1:StartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:StartDate>
          <d4p1:TakenSeats>1</d4p1:TakenSeats>
          <d4p1:TargetUserGroupTypeName>sample string 6</d4p1:TargetUserGroupTypeName>
          <d4p1:UserRoles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:UserRoles>
        </d4p1:ProductLicenseDto>
        <d4p1:ProductLicenseDto>
          <d4p1:AgreementEndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementEndDate>
          <d4p1:AgreementStartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:AgreementStartDate>
          <d4p1:AvailableSeats>1</d4p1:AvailableSeats>
          <d4p1:EndDate>2025-12-25T15:50:15.2440213+00:00</d4p1:EndDate>
          <d4p1:Id>a17222f7-3447-4242-8e6d-3263f698fb49</d4p1:Id>
          <d4p1:LicenseCategoryId>a472aaef-f26e-4e8c-bc99-0c418ca6239f</d4p1:LicenseCategoryId>
          <d4p1:LicenseCategoryName>sample string 4</d4p1:LicenseCategoryName>
          <d4p1:LicenseCategoryTypeId>1</d4p1:LicenseCategoryTypeId>
          <d4p1:LicenseCategoryTypeName>sample string 5</d4p1:LicenseCategoryTypeName>
          <d4p1:LicenseTypeId>2</d4p1:LicenseTypeId>
          <d4p1:LicenseTypeName>sample string 3</d4p1:LicenseTypeName>
          <d4p1:StartDate>2025-12-25T15:50:15.2440213+00:00</d4p1:StartDate>
          <d4p1:TakenSeats>1</d4p1:TakenSeats>
          <d4p1:TargetUserGroupTypeName>sample string 6</d4p1:TargetUserGroupTypeName>
          <d4p1:UserRoles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:UserRoles>
        </d4p1:ProductLicenseDto>
      </d2p1:Licenses>
      <d2p1:ProductAccessEndDate>2025-12-25T15:50:15.2440213+00:00</d2p1:ProductAccessEndDate>
      <d2p1:ProductAccessStartDate>2025-12-25T15:50:15.2440213+00:00</d2p1:ProductAccessStartDate>
      <d2p1:ProductName>sample string 1</d2p1:ProductName>
    </d2p1:GetLicensedProductDetailedResponse>
  </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>
</ApiCollectionResponseOfArrayOfGetLicensedProductDetailedResponseCOpN3Co1>