GET api/licenses/{licenseId}/licenseOrders

Returns license LicenseOrders

Request Information

URI Parameters

NameDescriptionTypeAdditional information
licenseId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ApiCollectionResponseOfIEnumerableOfGetLicenseLicenseOrdersResponse
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Errors

Collection of string

None.

Data

Collection of GetLicenseLicenseOrdersResponse

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": [
    {
      "LicenseOrderId": "70fdf8eb-5bdb-4531-8080-7d728f029b76",
      "LicenseOrderCreatedAt": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionStartDate": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionEndDate": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionNumber": "sample string 2",
      "Quantity": 3,
      "OrderRef": "sample string 4",
      "OrderActionTypeName": "sample string 5",
      "LicenseOrderAgreementActualAmount": 1.0,
      "LicenseOrderAgreementAgreementStartDate": "2025-12-25T15:51:44.0118877+00:00",
      "LicenseOrderAgreementAgreementEndDate": "2025-12-25T15:51:44.0118877+00:00",
      "LicenseOrderAgreementAgreementNumber": "sample string 6",
      "LicenseOrderAgreementContactNumber": "sample string 7",
      "LicenseOrderAgreementContactName": "sample string 8",
      "LicenseOrderAgreementLineDiscount": 1.0,
      "LicenseOrderAgreementLineDiscountAmount": 1.0,
      "LicenseOrderAgreementMunicipalityNumber": "sample string 9",
      "LicenseOrderAgreementMunicipalityAgreement": "sample string 10",
      "LicenseOrderAgreementMunicipalityName": "sample string 11",
      "LicenseOrderAgreementNumberOfMonthInvoiced": "sample string 12",
      "LicenseOrderAgreementNumberOfMonthAgreement": "sample string 13",
      "LicenseOrderAgreementTotalAmount": 1.0,
      "LicenseOrderAgreementRemainingAmount": 1.0
    },
    {
      "LicenseOrderId": "70fdf8eb-5bdb-4531-8080-7d728f029b76",
      "LicenseOrderCreatedAt": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionStartDate": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionEndDate": "2025-12-25T15:51:44.0118877+00:00",
      "SubscriptionNumber": "sample string 2",
      "Quantity": 3,
      "OrderRef": "sample string 4",
      "OrderActionTypeName": "sample string 5",
      "LicenseOrderAgreementActualAmount": 1.0,
      "LicenseOrderAgreementAgreementStartDate": "2025-12-25T15:51:44.0118877+00:00",
      "LicenseOrderAgreementAgreementEndDate": "2025-12-25T15:51:44.0118877+00:00",
      "LicenseOrderAgreementAgreementNumber": "sample string 6",
      "LicenseOrderAgreementContactNumber": "sample string 7",
      "LicenseOrderAgreementContactName": "sample string 8",
      "LicenseOrderAgreementLineDiscount": 1.0,
      "LicenseOrderAgreementLineDiscountAmount": 1.0,
      "LicenseOrderAgreementMunicipalityNumber": "sample string 9",
      "LicenseOrderAgreementMunicipalityAgreement": "sample string 10",
      "LicenseOrderAgreementMunicipalityName": "sample string 11",
      "LicenseOrderAgreementNumberOfMonthInvoiced": "sample string 12",
      "LicenseOrderAgreementNumberOfMonthAgreement": "sample string 13",
      "LicenseOrderAgreementTotalAmount": 1.0,
      "LicenseOrderAgreementRemainingAmount": 1.0
    }
  ],
  "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:
<ApiCollectionResponseOfArrayOfGetLicenseLicenseOrdersResponseLgVmlFmJ 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:GetLicenseLicenseOrdersResponse>
      <d2p1:LicenseOrderAgreementActualAmount>1</d2p1:LicenseOrderAgreementActualAmount>
      <d2p1:LicenseOrderAgreementAgreementEndDate>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderAgreementAgreementEndDate>
      <d2p1:LicenseOrderAgreementAgreementNumber>sample string 6</d2p1:LicenseOrderAgreementAgreementNumber>
      <d2p1:LicenseOrderAgreementAgreementStartDate>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderAgreementAgreementStartDate>
      <d2p1:LicenseOrderAgreementContactName>sample string 8</d2p1:LicenseOrderAgreementContactName>
      <d2p1:LicenseOrderAgreementContactNumber>sample string 7</d2p1:LicenseOrderAgreementContactNumber>
      <d2p1:LicenseOrderAgreementLineDiscount>1</d2p1:LicenseOrderAgreementLineDiscount>
      <d2p1:LicenseOrderAgreementLineDiscountAmount>1</d2p1:LicenseOrderAgreementLineDiscountAmount>
      <d2p1:LicenseOrderAgreementMunicipalityAgreement>sample string 10</d2p1:LicenseOrderAgreementMunicipalityAgreement>
      <d2p1:LicenseOrderAgreementMunicipalityName>sample string 11</d2p1:LicenseOrderAgreementMunicipalityName>
      <d2p1:LicenseOrderAgreementMunicipalityNumber>sample string 9</d2p1:LicenseOrderAgreementMunicipalityNumber>
      <d2p1:LicenseOrderAgreementNumberOfMonthAgreement>sample string 13</d2p1:LicenseOrderAgreementNumberOfMonthAgreement>
      <d2p1:LicenseOrderAgreementNumberOfMonthInvoiced>sample string 12</d2p1:LicenseOrderAgreementNumberOfMonthInvoiced>
      <d2p1:LicenseOrderAgreementRemainingAmount>1</d2p1:LicenseOrderAgreementRemainingAmount>
      <d2p1:LicenseOrderAgreementTotalAmount>1</d2p1:LicenseOrderAgreementTotalAmount>
      <d2p1:LicenseOrderCreatedAt>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderCreatedAt>
      <d2p1:LicenseOrderId>70fdf8eb-5bdb-4531-8080-7d728f029b76</d2p1:LicenseOrderId>
      <d2p1:OrderActionTypeName>sample string 5</d2p1:OrderActionTypeName>
      <d2p1:OrderRef>sample string 4</d2p1:OrderRef>
      <d2p1:Quantity>3</d2p1:Quantity>
      <d2p1:SubscriptionEndDate>2025-12-25T15:51:44.0118877+00:00</d2p1:SubscriptionEndDate>
      <d2p1:SubscriptionNumber>sample string 2</d2p1:SubscriptionNumber>
      <d2p1:SubscriptionStartDate>2025-12-25T15:51:44.0118877+00:00</d2p1:SubscriptionStartDate>
    </d2p1:GetLicenseLicenseOrdersResponse>
    <d2p1:GetLicenseLicenseOrdersResponse>
      <d2p1:LicenseOrderAgreementActualAmount>1</d2p1:LicenseOrderAgreementActualAmount>
      <d2p1:LicenseOrderAgreementAgreementEndDate>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderAgreementAgreementEndDate>
      <d2p1:LicenseOrderAgreementAgreementNumber>sample string 6</d2p1:LicenseOrderAgreementAgreementNumber>
      <d2p1:LicenseOrderAgreementAgreementStartDate>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderAgreementAgreementStartDate>
      <d2p1:LicenseOrderAgreementContactName>sample string 8</d2p1:LicenseOrderAgreementContactName>
      <d2p1:LicenseOrderAgreementContactNumber>sample string 7</d2p1:LicenseOrderAgreementContactNumber>
      <d2p1:LicenseOrderAgreementLineDiscount>1</d2p1:LicenseOrderAgreementLineDiscount>
      <d2p1:LicenseOrderAgreementLineDiscountAmount>1</d2p1:LicenseOrderAgreementLineDiscountAmount>
      <d2p1:LicenseOrderAgreementMunicipalityAgreement>sample string 10</d2p1:LicenseOrderAgreementMunicipalityAgreement>
      <d2p1:LicenseOrderAgreementMunicipalityName>sample string 11</d2p1:LicenseOrderAgreementMunicipalityName>
      <d2p1:LicenseOrderAgreementMunicipalityNumber>sample string 9</d2p1:LicenseOrderAgreementMunicipalityNumber>
      <d2p1:LicenseOrderAgreementNumberOfMonthAgreement>sample string 13</d2p1:LicenseOrderAgreementNumberOfMonthAgreement>
      <d2p1:LicenseOrderAgreementNumberOfMonthInvoiced>sample string 12</d2p1:LicenseOrderAgreementNumberOfMonthInvoiced>
      <d2p1:LicenseOrderAgreementRemainingAmount>1</d2p1:LicenseOrderAgreementRemainingAmount>
      <d2p1:LicenseOrderAgreementTotalAmount>1</d2p1:LicenseOrderAgreementTotalAmount>
      <d2p1:LicenseOrderCreatedAt>2025-12-25T15:51:44.0118877+00:00</d2p1:LicenseOrderCreatedAt>
      <d2p1:LicenseOrderId>70fdf8eb-5bdb-4531-8080-7d728f029b76</d2p1:LicenseOrderId>
      <d2p1:OrderActionTypeName>sample string 5</d2p1:OrderActionTypeName>
      <d2p1:OrderRef>sample string 4</d2p1:OrderRef>
      <d2p1:Quantity>3</d2p1:Quantity>
      <d2p1:SubscriptionEndDate>2025-12-25T15:51:44.0118877+00:00</d2p1:SubscriptionEndDate>
      <d2p1:SubscriptionNumber>sample string 2</d2p1:SubscriptionNumber>
      <d2p1:SubscriptionStartDate>2025-12-25T15:51:44.0118877+00:00</d2p1:SubscriptionStartDate>
    </d2p1:GetLicenseLicenseOrdersResponse>
  </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>
</ApiCollectionResponseOfArrayOfGetLicenseLicenseOrdersResponseLgVmlFmJ>