Lists the entitlements made from an offer, newest first, each with whether it deviates from what the offer gave it and why: its plan changed since, or an add-on revoked or added for that customer alone. Try licenses are left out.
const url = 'https://example.com/api/v1/provision/admin/entitlements/offers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/entitlements?pageNumber=1&pageSize=100';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/provision/admin/entitlements/offers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/entitlements?pageNumber=1&pageSize=100'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The offer.
Query Parameters
Section titled “Query Parameters”1-based page number to return.
Maximum number of items per page.
Responses
Section titled “Responses”OK
Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Example
{ "items": [ { "status": "Draft", "deviations": [ { "facet": "Plan" } ] } ]}Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Example
{ "items": [ { "status": "Draft", "deviations": [ { "facet": "Plan" } ] } ]}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}