GET api/products/getForInstitution?institutionNumber={institutionNumber}&isbn={isbn}&includeLicenses={includeLicenses}

Retrieves licensed products for institution

Request Information

URI Parameters

Name	Type	Additional information
institutionNumber	string	Required
isbn	string	None.
includeLicenses	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of GetLicensedProductResponse

Name	Type	Additional information
Isbn	string	None.
ProductAccessStartDate	date	None.
ProductAccessEndDate	date	None.
Licenses	Collection of ProductLicenseDto	None.

Response Formats

application/xml, text/xml

Sample:

<ArrayOfGetLicensedProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses.Product">
  <GetLicensedProductResponse>
    <Isbn>sample string 1</Isbn>
    <Licenses xmlns:d3p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
      <d3p1:ProductLicenseDto>
        <d3p1:AgreementEndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementEndDate>
        <d3p1:AgreementStartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementStartDate>
        <d3p1:AvailableSeats>1</d3p1:AvailableSeats>
        <d3p1:EndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:EndDate>
        <d3p1:Id>d72941dc-39be-42e4-ae43-cd8bf101cdf3</d3p1:Id>
        <d3p1:LicenseCategoryId>0f656980-a6b5-44d4-b288-f783ebc09254</d3p1:LicenseCategoryId>
        <d3p1:LicenseCategoryName>sample string 4</d3p1:LicenseCategoryName>
        <d3p1:LicenseCategoryTypeId>1</d3p1:LicenseCategoryTypeId>
        <d3p1:LicenseCategoryTypeName>sample string 5</d3p1:LicenseCategoryTypeName>
        <d3p1:LicenseTypeId>2</d3p1:LicenseTypeId>
        <d3p1:LicenseTypeName>sample string 3</d3p1:LicenseTypeName>
        <d3p1:StartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:StartDate>
        <d3p1:TakenSeats>1</d3p1:TakenSeats>
        <d3p1:TargetUserGroupTypeName>sample string 6</d3p1:TargetUserGroupTypeName>
        <d3p1:UserRoles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:UserRoles>
      </d3p1:ProductLicenseDto>
      <d3p1:ProductLicenseDto>
        <d3p1:AgreementEndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementEndDate>
        <d3p1:AgreementStartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementStartDate>
        <d3p1:AvailableSeats>1</d3p1:AvailableSeats>
        <d3p1:EndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:EndDate>
        <d3p1:Id>d72941dc-39be-42e4-ae43-cd8bf101cdf3</d3p1:Id>
        <d3p1:LicenseCategoryId>0f656980-a6b5-44d4-b288-f783ebc09254</d3p1:LicenseCategoryId>
        <d3p1:LicenseCategoryName>sample string 4</d3p1:LicenseCategoryName>
        <d3p1:LicenseCategoryTypeId>1</d3p1:LicenseCategoryTypeId>
        <d3p1:LicenseCategoryTypeName>sample string 5</d3p1:LicenseCategoryTypeName>
        <d3p1:LicenseTypeId>2</d3p1:LicenseTypeId>
        <d3p1:LicenseTypeName>sample string 3</d3p1:LicenseTypeName>
        <d3p1:StartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:StartDate>
        <d3p1:TakenSeats>1</d3p1:TakenSeats>
        <d3p1:TargetUserGroupTypeName>sample string 6</d3p1:TargetUserGroupTypeName>
        <d3p1:UserRoles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:UserRoles>
      </d3p1:ProductLicenseDto>
    </Licenses>
    <ProductAccessEndDate>2025-12-25T16:08:34.2171075+00:00</ProductAccessEndDate>
    <ProductAccessStartDate>2025-12-25T16:08:34.2171075+00:00</ProductAccessStartDate>
  </GetLicensedProductResponse>
  <GetLicensedProductResponse>
    <Isbn>sample string 1</Isbn>
    <Licenses xmlns:d3p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Dtos">
      <d3p1:ProductLicenseDto>
        <d3p1:AgreementEndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementEndDate>
        <d3p1:AgreementStartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementStartDate>
        <d3p1:AvailableSeats>1</d3p1:AvailableSeats>
        <d3p1:EndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:EndDate>
        <d3p1:Id>d72941dc-39be-42e4-ae43-cd8bf101cdf3</d3p1:Id>
        <d3p1:LicenseCategoryId>0f656980-a6b5-44d4-b288-f783ebc09254</d3p1:LicenseCategoryId>
        <d3p1:LicenseCategoryName>sample string 4</d3p1:LicenseCategoryName>
        <d3p1:LicenseCategoryTypeId>1</d3p1:LicenseCategoryTypeId>
        <d3p1:LicenseCategoryTypeName>sample string 5</d3p1:LicenseCategoryTypeName>
        <d3p1:LicenseTypeId>2</d3p1:LicenseTypeId>
        <d3p1:LicenseTypeName>sample string 3</d3p1:LicenseTypeName>
        <d3p1:StartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:StartDate>
        <d3p1:TakenSeats>1</d3p1:TakenSeats>
        <d3p1:TargetUserGroupTypeName>sample string 6</d3p1:TargetUserGroupTypeName>
        <d3p1:UserRoles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:UserRoles>
      </d3p1:ProductLicenseDto>
      <d3p1:ProductLicenseDto>
        <d3p1:AgreementEndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementEndDate>
        <d3p1:AgreementStartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:AgreementStartDate>
        <d3p1:AvailableSeats>1</d3p1:AvailableSeats>
        <d3p1:EndDate>2025-12-25T16:08:34.2171075+00:00</d3p1:EndDate>
        <d3p1:Id>d72941dc-39be-42e4-ae43-cd8bf101cdf3</d3p1:Id>
        <d3p1:LicenseCategoryId>0f656980-a6b5-44d4-b288-f783ebc09254</d3p1:LicenseCategoryId>
        <d3p1:LicenseCategoryName>sample string 4</d3p1:LicenseCategoryName>
        <d3p1:LicenseCategoryTypeId>1</d3p1:LicenseCategoryTypeId>
        <d3p1:LicenseCategoryTypeName>sample string 5</d3p1:LicenseCategoryTypeName>
        <d3p1:LicenseTypeId>2</d3p1:LicenseTypeId>
        <d3p1:LicenseTypeName>sample string 3</d3p1:LicenseTypeName>
        <d3p1:StartDate>2025-12-25T16:08:34.2171075+00:00</d3p1:StartDate>
        <d3p1:TakenSeats>1</d3p1:TakenSeats>
        <d3p1:TargetUserGroupTypeName>sample string 6</d3p1:TargetUserGroupTypeName>
        <d3p1:UserRoles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:UserRoles>
      </d3p1:ProductLicenseDto>
    </Licenses>
    <ProductAccessEndDate>2025-12-25T16:08:34.2171075+00:00</ProductAccessEndDate>
    <ProductAccessStartDate>2025-12-25T16:08:34.2171075+00:00</ProductAccessStartDate>
  </GetLicensedProductResponse>
</ArrayOfGetLicensedProductResponse>

application/json, text/json

Sample:

[
  {
    "Isbn": "sample string 1",
    "ProductAccessStartDate": "2025-12-25T16:08:34.2171075+00:00",
    "ProductAccessEndDate": "2025-12-25T16:08:34.2171075+00:00",
    "Licenses": [
      {
        "Id": "d72941dc-39be-42e4-ae43-cd8bf101cdf3",
        "StartDate": "2025-12-25T16:08:34.2171075+00:00",
        "EndDate": "2025-12-25T16:08:34.2171075+00:00",
        "LicenseTypeId": 2,
        "LicenseTypeName": "sample string 3",
        "LicenseCategoryId": "0f656980-a6b5-44d4-b288-f783ebc09254",
        "LicenseCategoryName": "sample string 4",
        "LicenseCategoryTypeId": 1,
        "LicenseCategoryTypeName": "sample string 5",
        "UserRoles": [
          "sample string 1",
          "sample string 2"
        ],
        "AgreementStartDate": "2025-12-25T16:08:34.2171075+00:00",
        "AgreementEndDate": "2025-12-25T16:08:34.2171075+00:00",
        "AvailableSeats": 1,
        "TakenSeats": 1,
        "TargetUserGroupTypeName": "sample string 6"
      },
      {
        "Id": "d72941dc-39be-42e4-ae43-cd8bf101cdf3",
        "StartDate": "2025-12-25T16:08:34.2171075+00:00",
        "EndDate": "2025-12-25T16:08:34.2171075+00:00",
        "LicenseTypeId": 2,
        "LicenseTypeName": "sample string 3",
        "LicenseCategoryId": "0f656980-a6b5-44d4-b288-f783ebc09254",
        "LicenseCategoryName": "sample string 4",
        "LicenseCategoryTypeId": 1,
        "LicenseCategoryTypeName": "sample string 5",
        "UserRoles": [
          "sample string 1",
          "sample string 2"
        ],
        "AgreementStartDate": "2025-12-25T16:08:34.2171075+00:00",
        "AgreementEndDate": "2025-12-25T16:08:34.2171075+00:00",
        "AvailableSeats": 1,
        "TakenSeats": 1,
        "TargetUserGroupTypeName": "sample string 6"
      }
    ]
  },
  {
    "Isbn": "sample string 1",
    "ProductAccessStartDate": "2025-12-25T16:08:34.2171075+00:00",
    "ProductAccessEndDate": "2025-12-25T16:08:34.2171075+00:00",
    "Licenses": [
      {
        "Id": "d72941dc-39be-42e4-ae43-cd8bf101cdf3",
        "StartDate": "2025-12-25T16:08:34.2171075+00:00",
        "EndDate": "2025-12-25T16:08:34.2171075+00:00",
        "LicenseTypeId": 2,
        "LicenseTypeName": "sample string 3",
        "LicenseCategoryId": "0f656980-a6b5-44d4-b288-f783ebc09254",
        "LicenseCategoryName": "sample string 4",
        "LicenseCategoryTypeId": 1,
        "LicenseCategoryTypeName": "sample string 5",
        "UserRoles": [
          "sample string 1",
          "sample string 2"
        ],
        "AgreementStartDate": "2025-12-25T16:08:34.2171075+00:00",
        "AgreementEndDate": "2025-12-25T16:08:34.2171075+00:00",
        "AvailableSeats": 1,
        "TakenSeats": 1,
        "TargetUserGroupTypeName": "sample string 6"
      },
      {
        "Id": "d72941dc-39be-42e4-ae43-cd8bf101cdf3",
        "StartDate": "2025-12-25T16:08:34.2171075+00:00",
        "EndDate": "2025-12-25T16:08:34.2171075+00:00",
        "LicenseTypeId": 2,
        "LicenseTypeName": "sample string 3",
        "LicenseCategoryId": "0f656980-a6b5-44d4-b288-f783ebc09254",
        "LicenseCategoryName": "sample string 4",
        "LicenseCategoryTypeId": 1,
        "LicenseCategoryTypeName": "sample string 5",
        "UserRoles": [
          "sample string 1",
          "sample string 2"
        ],
        "AgreementStartDate": "2025-12-25T16:08:34.2171075+00:00",
        "AgreementEndDate": "2025-12-25T16:08:34.2171075+00:00",
        "AvailableSeats": 1,
        "TakenSeats": 1,
        "TargetUserGroupTypeName": "sample string 6"
      }
    ]
  }
]