POST api/LicenseReport/Get

Returns all licenses in specific Account context based on provided filters

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FilterOwnerInstitutionNumber	string	None.
FilterOwnerName	string	None.
FilterOwnerType	string	None.
FilterOwnerMunicipality	string	None.
FilterOwnerMunicipalityAdministrative	string	None.
FilterWs17	string	None.
FilterIsbn	string	None.
FilterProductName	string	None.
FilterProductGroup	string	None.
FilterProductTopic	string	None.
FilterProductTarget	string	None.
FilterProductImprint	string	None.
FilterStartDate	string	None.
FilterEndDate	string	None.
FilterLicenseType	string	None.
FilterAccessType	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:

{
  "FilterOwnerInstitutionNumber": "OwnerInstitutionerNumber",
  "FilterOwnerName": "OwnerName",
  "FilterOwnerType": "OwnerType",
  "FilterOwnerMunicipality": "OwnerMunicipality",
  "FilterOwnerMunicipalityAdministrative": "OwnerMunicipalityAdministrative",
  "FilterWs17": "Ws17",
  "FilterIsbn": "ProductIsbn",
  "FilterProductName": "ProductName",
  "FilterProductGroup": "ProductGroup",
  "FilterProductTopic": "ProductTopic",
  "FilterProductTarget": "ProductTarget",
  "FilterProductImprint": "ProductImprint",
  "FilterStartDate": "StartDate",
  "FilterEndDate": "EndDate",
  "FilterLicenseType": "LicenseType",
  "FilterAccessType": "AccessType",
  "Filters": {
    "OwnerInstitutionerNumber": {
      "Value": "",
      "FilterType": 0
    },
    "OwnerName": {
      "Value": "",
      "FilterType": 0
    },
    "OwnerType": {
      "Value": "",
      "FilterType": 0
    },
    "OwnerMunicipality": {
      "Value": "",
      "FilterType": 0
    },
    "OwnerMunicipalityAdministrative": {
      "Value": "",
      "FilterType": 0
    },
    "Ws17": {
      "Value": "",
      "FilterType": 0
    },
    "ProductIsbn": {
      "Value": "",
      "FilterType": 0
    },
    "ProductName": {
      "Value": "",
      "FilterType": 0
    },
    "ProductGroup": {
      "Value": "",
      "FilterType": 0
    },
    "ProductTopic": {
      "Value": "",
      "FilterType": 0
    },
    "ProductTarget": {
      "Value": "",
      "FilterType": 0
    },
    "ProductImprint": {
      "Value": "",
      "FilterType": 0
    },
    "StartDate": {
      "Value": "",
      "FilterType": 0
    },
    "EndDate": {
      "Value": "",
      "FilterType": 0
    },
    "LicenseType": {
      "Value": "",
      "FilterType": 0
    },
    "AccessType": {
      "Value": "",
      "FilterType": 0
    }
  },
  "SortFields": {},
  "AvailablePageSizes": [
    10,
    50,
    100
  ],
  "PageSize": 1,
  "PageIndex": 2
}

application/xml, text/xml

Sample:

<GetLicensesReportRequest 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">
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>OwnerInstitutionerNumber</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>OwnerName</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>OwnerType</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>OwnerMunicipality</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>OwnerMunicipalityAdministrative</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>Ws17</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductIsbn</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductName</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductGroup</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductTopic</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductTarget</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>ProductImprint</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>StartDate</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>EndDate</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>LicenseType</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>AccessType</d2p1:Key>
      <d2p1:Value>
        <FilterType>None</FilterType>
        <Value></Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
  </Filters>
  <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" />
</GetLicensesReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiCollectionResponseOfIEnumerableOfGetLicenseReportResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Errors	Collection of string	None.
Data	Collection of GetLicenseReportResponse	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": [
    {
      "OwnerName": "sample string 1",
      "OwnerInstitutionNumber": "sample string 2",
      "OwnerType": "sample string 3",
      "OwnerAddess": "sample string 4",
      "OwnerPostalCode": "sample string 5",
      "OwnerCity": "sample string 6",
      "OwnerMunisipality": "sample string 7",
      "OwnerMunisipalityAdministrative": "sample string 8",
      "OwnerContactName": "sample string 9",
      "OwnerContactEmail": "sample string 10",
      "IsOwnerBlocked": true,
      "ProductName": "sample string 12",
      "LicenseNumber": "sample string 13",
      "OrderNumber": "sample string 14",
      "StartDate": "sample string 15",
      "EndDate": "sample string 16",
      "LicenseContactName": "sample string 17",
      "LicenseContactEmail": "sample string 18",
      "LicenseType": "sample string 19",
      "LicenseAccessType": "sample string 20",
      "IsLicenseActive": true,
      "ProductIsbn": "sample string 22",
      "ProductGroup": "sample string 23",
      "ProductTarget": "sample string 24",
      "ProductTopic": "sample string 25",
      "ProductImprint": "sample string 26",
      "Ws17": true,
      "LicenseContactPhoneNumber": "sample string 28"
    },
    {
      "OwnerName": "sample string 1",
      "OwnerInstitutionNumber": "sample string 2",
      "OwnerType": "sample string 3",
      "OwnerAddess": "sample string 4",
      "OwnerPostalCode": "sample string 5",
      "OwnerCity": "sample string 6",
      "OwnerMunisipality": "sample string 7",
      "OwnerMunisipalityAdministrative": "sample string 8",
      "OwnerContactName": "sample string 9",
      "OwnerContactEmail": "sample string 10",
      "IsOwnerBlocked": true,
      "ProductName": "sample string 12",
      "LicenseNumber": "sample string 13",
      "OrderNumber": "sample string 14",
      "StartDate": "sample string 15",
      "EndDate": "sample string 16",
      "LicenseContactName": "sample string 17",
      "LicenseContactEmail": "sample string 18",
      "LicenseType": "sample string 19",
      "LicenseAccessType": "sample string 20",
      "IsLicenseActive": true,
      "ProductIsbn": "sample string 22",
      "ProductGroup": "sample string 23",
      "ProductTarget": "sample string 24",
      "ProductTopic": "sample string 25",
      "ProductImprint": "sample string 26",
      "Ws17": true,
      "LicenseContactPhoneNumber": "sample string 28"
    }
  ],
  "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:

<ApiCollectionResponseOfArrayOfGetLicenseReportResponseLgVmlFmJ 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">
    <d2p1:GetLicenseReportResponse>
      <d2p1:EndDate>sample string 16</d2p1:EndDate>
      <d2p1:IsLicenseActive>true</d2p1:IsLicenseActive>
      <d2p1:IsOwnerBlocked>true</d2p1:IsOwnerBlocked>
      <d2p1:LicenseAccessType>sample string 20</d2p1:LicenseAccessType>
      <d2p1:LicenseContactEmail>sample string 18</d2p1:LicenseContactEmail>
      <d2p1:LicenseContactName>sample string 17</d2p1:LicenseContactName>
      <d2p1:LicenseContactPhoneNumber>sample string 28</d2p1:LicenseContactPhoneNumber>
      <d2p1:LicenseNumber>sample string 13</d2p1:LicenseNumber>
      <d2p1:LicenseType>sample string 19</d2p1:LicenseType>
      <d2p1:OrderNumber>sample string 14</d2p1:OrderNumber>
      <d2p1:OwnerAddess>sample string 4</d2p1:OwnerAddess>
      <d2p1:OwnerCity>sample string 6</d2p1:OwnerCity>
      <d2p1:OwnerContactEmail>sample string 10</d2p1:OwnerContactEmail>
      <d2p1:OwnerContactName>sample string 9</d2p1:OwnerContactName>
      <d2p1:OwnerInstitutionNumber>sample string 2</d2p1:OwnerInstitutionNumber>
      <d2p1:OwnerMunisipality>sample string 7</d2p1:OwnerMunisipality>
      <d2p1:OwnerMunisipalityAdministrative>sample string 8</d2p1:OwnerMunisipalityAdministrative>
      <d2p1:OwnerName>sample string 1</d2p1:OwnerName>
      <d2p1:OwnerPostalCode>sample string 5</d2p1:OwnerPostalCode>
      <d2p1:OwnerType>sample string 3</d2p1:OwnerType>
      <d2p1:ProductGroup>sample string 23</d2p1:ProductGroup>
      <d2p1:ProductImprint>sample string 26</d2p1:ProductImprint>
      <d2p1:ProductIsbn>sample string 22</d2p1:ProductIsbn>
      <d2p1:ProductName>sample string 12</d2p1:ProductName>
      <d2p1:ProductTarget>sample string 24</d2p1:ProductTarget>
      <d2p1:ProductTopic>sample string 25</d2p1:ProductTopic>
      <d2p1:StartDate>sample string 15</d2p1:StartDate>
      <d2p1:Ws17>true</d2p1:Ws17>
    </d2p1:GetLicenseReportResponse>
    <d2p1:GetLicenseReportResponse>
      <d2p1:EndDate>sample string 16</d2p1:EndDate>
      <d2p1:IsLicenseActive>true</d2p1:IsLicenseActive>
      <d2p1:IsOwnerBlocked>true</d2p1:IsOwnerBlocked>
      <d2p1:LicenseAccessType>sample string 20</d2p1:LicenseAccessType>
      <d2p1:LicenseContactEmail>sample string 18</d2p1:LicenseContactEmail>
      <d2p1:LicenseContactName>sample string 17</d2p1:LicenseContactName>
      <d2p1:LicenseContactPhoneNumber>sample string 28</d2p1:LicenseContactPhoneNumber>
      <d2p1:LicenseNumber>sample string 13</d2p1:LicenseNumber>
      <d2p1:LicenseType>sample string 19</d2p1:LicenseType>
      <d2p1:OrderNumber>sample string 14</d2p1:OrderNumber>
      <d2p1:OwnerAddess>sample string 4</d2p1:OwnerAddess>
      <d2p1:OwnerCity>sample string 6</d2p1:OwnerCity>
      <d2p1:OwnerContactEmail>sample string 10</d2p1:OwnerContactEmail>
      <d2p1:OwnerContactName>sample string 9</d2p1:OwnerContactName>
      <d2p1:OwnerInstitutionNumber>sample string 2</d2p1:OwnerInstitutionNumber>
      <d2p1:OwnerMunisipality>sample string 7</d2p1:OwnerMunisipality>
      <d2p1:OwnerMunisipalityAdministrative>sample string 8</d2p1:OwnerMunisipalityAdministrative>
      <d2p1:OwnerName>sample string 1</d2p1:OwnerName>
      <d2p1:OwnerPostalCode>sample string 5</d2p1:OwnerPostalCode>
      <d2p1:OwnerType>sample string 3</d2p1:OwnerType>
      <d2p1:ProductGroup>sample string 23</d2p1:ProductGroup>
      <d2p1:ProductImprint>sample string 26</d2p1:ProductImprint>
      <d2p1:ProductIsbn>sample string 22</d2p1:ProductIsbn>
      <d2p1:ProductName>sample string 12</d2p1:ProductName>
      <d2p1:ProductTarget>sample string 24</d2p1:ProductTarget>
      <d2p1:ProductTopic>sample string 25</d2p1:ProductTopic>
      <d2p1:StartDate>sample string 15</d2p1:StartDate>
      <d2p1:Ws17>true</d2p1:Ws17>
    </d2p1:GetLicenseReportResponse>
  </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>
</ApiCollectionResponseOfArrayOfGetLicenseReportResponseLgVmlFmJ>