GET /api/v1/License

Description: Returns a list of licenses linked to your company.

Url: https://serviceapi.episerver.com/api/v1/License

Http method: GET

Request

Request headers

Accept: application/json, text/json, application/xml, text/xml,

HTTP Request Example

GET https://serviceapi.episerver.com/api/v1/License?apikey=xxx{&CustomerId=1}
Accept:application/xml

URI Parameters

Field name Description Type Optional Default
CustomerId Filter licenses by end customer company. integer
Yes

Response

Successful HTTP Response: 200 Status Code

Responce Body

Field name Description Type
TotalCount integer
Records V1LicenseDto
Records.Id License id. integer
Records.ProductName Name of the license type. string
Records.MinVersion Lowest version supported by a license. string
Records.MaxVersion Highest version supported by a license. string
Records.LicensedTo Name of end customers company. string
Records.BoundTo IP or Mac address the license is bound to. Or If bundled with another license, it´s that license id. string
Records.Created When the license was created. date
Records.ExpirationDate When the license expires. date
Records.Url Url to end customers site. string
Records.MultiSiteLimit Number of sites a license can support. Null or 0 equals 1 site. integer
Records.CustomerId Id of end customers company. integer
Records.CustomerContactId Id of end customer contact. integer
Records.PartnerId Id of partner company. integer
Records.PartnerContactId Id of partner company contact. integer
Records.MasterLicenseId Id reference to master license. Null if license is not a slave license. integer

Response Format

{
  "TotalCount": 1,
  "Records": [
    {
      "Id": 1,
      "ProductName": "sample string 2",
      "MinVersion": "sample string 3",
      "MaxVersion": "sample string 4",
      "LicensedTo": "sample string 5",
      "BoundTo": "sample string 6",
      "Created": "2021-08-02T14:09:47.9302255+02:00",
      "ExpirationDate": "2021-08-02T14:09:47.9302255+02:00",
      "Url": "sample string 9",
      "MultiSiteLimit": 1,
      "CustomerId": 1,
      "CustomerContactId": 1,
      "PartnerId": 1,
      "PartnerContactId": 1,
      "MasterLicenseId": 1
    },
    {
      "Id": 1,
      "ProductName": "sample string 2",
      "MinVersion": "sample string 3",
      "MaxVersion": "sample string 4",
      "LicensedTo": "sample string 5",
      "BoundTo": "sample string 6",
      "Created": "2021-08-02T14:09:47.9302255+02:00",
      "ExpirationDate": "2021-08-02T14:09:47.9302255+02:00",
      "Url": "sample string 9",
      "MultiSiteLimit": 1,
      "CustomerId": 1,
      "CustomerContactId": 1,
      "PartnerId": 1,
      "PartnerContactId": 1,
      "MasterLicenseId": 1
    }
  ]
}


<V1ResponseModelOfV1LicenseDto xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalCount>1</TotalCount>
  <Records>
    <License>
      <Id>1</Id>
      <ProductName>sample string 2</ProductName>
      <MinVersion>sample string 3</MinVersion>
      <MaxVersion>sample string 4</MaxVersion>
      <LicensedTo>sample string 5</LicensedTo>
      <BoundTo>sample string 6</BoundTo>
      <Created>2021-08-02T14:09:47.9302255+02:00</Created>
      <ExpirationDate>2021-08-02T14:09:47.9302255+02:00</ExpirationDate>
      <Url>sample string 9</Url>
      <MultiSiteLimit>1</MultiSiteLimit>
      <CustomerId>1</CustomerId>
      <CustomerContactId>1</CustomerContactId>
      <PartnerId>1</PartnerId>
      <PartnerContactId>1</PartnerContactId>
      <MasterLicenseId>1</MasterLicenseId>
    </License>
    <License>
      <Id>1</Id>
      <ProductName>sample string 2</ProductName>
      <MinVersion>sample string 3</MinVersion>
      <MaxVersion>sample string 4</MaxVersion>
      <LicensedTo>sample string 5</LicensedTo>
      <BoundTo>sample string 6</BoundTo>
      <Created>2021-08-02T14:09:47.9302255+02:00</Created>
      <ExpirationDate>2021-08-02T14:09:47.9302255+02:00</ExpirationDate>
      <Url>sample string 9</Url>
      <MultiSiteLimit>1</MultiSiteLimit>
      <CustomerId>1</CustomerId>
      <CustomerContactId>1</CustomerContactId>
      <PartnerId>1</PartnerId>
      <PartnerContactId>1</PartnerContactId>
      <MasterLicenseId>1</MasterLicenseId>
    </License>
  </Records>
</V1ResponseModelOfV1LicenseDto>

Error Response

Error HTTP Response: Error Status Codes

Status Code Description
200 OK Successfull request
400 Bad Request Path variable may be invalid
403 Forbidden Insufficient role
404 Not Found Request not found
405 Method Not Allowed Request method not allowed
500 Internal Server Error Unexpected server error

Error Body

Field name Description Type
StatusCode The HTTP status code. String
StatusDesc Description of HTTP status code. String
ErrorMessage Additional information. String

Response Format

{
  "StatusCode": "sample string 1",
  "StatusDesc": "sample string 2",
  "ErrorMessage": "sample string 3"
}