Get the details for all Promotion Offer Instances

get

https://api.worldov.net/v1/ratingengine/promotion_offer_instances

This endpoint will return details on all Promotion Offer Instances

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

The Id of the Promotion Offer Instance

PromotionOfferId

int32

The Promotion Offer linked to the Promotion Offer Instance

PromotionId

int32

The Promotion linked to the Promotion Offer Instance

SimIccids

array of strings

The Iccids of the Sim Cards linked to the Promotion Offer Instance.

SimIccids

StartDateFrom

date-time

The start date to search from for the Promotion Offer Instance

Inclusive of the specified date and time

StartDateTo

date-time

The start date to search to for the Promotion Offer Instance

Exclusive of the specified date and time

EndDateFrom

date-time

The end date to search from for the Promotion Offer Instance

Inclusive of the specified date and time

EndDateTo

date-time

The end date to search to for the Promotion Offer Instance

Exclusive of the specified date and time

AppliedTimeFrom

date-time

The applied time to search from for the Promotion Offer Instance

Inclusive of the specified date and time

AppliedTimeTo

date-time

The applied time to search to for the Promotion Offer Instance

Exclusive of the specified date and time

Ordinal

int32

A number representing the order of usage for the Promotion Offer Instance

AutoStarted

boolean

Whether to automatically start the Promotion Offer Instance

IsFinished

boolean

Whether the Promotion Offer Instance has finished

ThrottlingActive

boolean

Whether Throttling is active for the Promotion Offer Instance

IsRenewed

boolean

Whether the Promotion Offer Instance has been renewed or not

RenewalCount

int32

The number of times the Promotion Offer Instance has been renewed (increments with each new instance)

SimPartnerId

int32

The Sim Partner linked to the Promotion Offer Instance

AllowDescendantPartners

boolean

Whether to show Promotion Offer Instances for all descendant Partners of the specified CMP.RatingEngine.Core.Dtos.PromotionOfferInstanceDto.GetPagedPromotionOfferInstancesRequestDto.SimPartnerId Defaults to true

SortOption

string

enum

The Sort Option to use when ordering results

Allowed:

SortDirection

string

enum

The Sort Direction to use when ordering by the specified CMP.RatingEngine.Core.Dtos.PromotionOfferInstanceDto.GetPagedPromotionOfferInstancesRequestDto.SortOption

Allowed:

page_number

int32

The requested page, starting and defaulting to a minimum of 1.

page_size

int32

The number of items to be returned per page, defaulting to a minimum of 1.

Responses

401

Unauthorized

200OK

400Bad Request

404Not Found