Get the details for all Active Promotions

get

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

This endpoint will return details on all Active Promotions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

The Id of the Active Promotion

PromotionOfferInstanceId

int32

The Promotion Offer Instance linked to the Active Promotion

PromotionOfferId

int32

The Promotion Offer linked to the Active Promotion

PromotionId

int32

The Promotion linked to the Active Promotion

SimIccids

array of strings

The Iccids of the Sim Cards linked to the Active Promotion

SimIccids

StartTimeFrom

date-time

The start time to search from for the Active Promotion

Inclusive of the specified date and time

StartTimeTo

date-time

The start time to search to for the Active Promotion

Exclusive of the specified date and time

EndTimeFrom

date-time

The end time to search from for the Active Promotion

Inclusive of the specified date and time

EndTimeTo

date-time

The end time to search to for the Active Promotion

Exclusive of the specified date and time

LastUpdatedFrom

date-time

The last updated time to search from for the Active Promotion

Inclusive of the specified date and time

LastUpdatedTo

date-time

The last updated time to search to for the Active Promotion

Exclusive of the specified date and time

CallTypeId

int32

The Call Type the Active Promotion applies to

OriginatingMobileNetworkId

int32

The Mobile Network the Active Promotion applies to for origination traffic

DestinationMobileNetworkId

int32

The Mobile Network the Active Promotion applies to for destination traffic (voice + sms only)

NetworkProfileId

int32

The Network Profile the Active Promotion applies to

ServingMSC

string

The global title of the mobile switching centre the Active Promotion applies to

CallId

string

The Id of the call the Active Promotion applies to

ConsultationRequestId

uuid

The unique Id of the call within PIP that the Active Promotion applies to

PipCdrId

int64

The Id of the PIP Call Data Record that the Active Promotion applies to

SimPartnerId

int32

The Sim Partner linked to the Active Promotion

AllowDescendantPartners

boolean

Whether to show Active Promotions for all descendant Partners of the specified CMP.RatingEngine.WebAPI.Dtos.ActivePromotions.GetPagedActivePromotionRequestDto.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.WebAPI.Dtos.ActivePromotions.GetPagedActivePromotionRequestDto.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