Deactivate policy rule

Deactivates policy rules.

GET /sponsordata/sds/campaigns/deactivate?{requestParametersGoHere}

accept: application/JSON/XML

The SDGW, upon the OCSG accepting the activation request, schedules a trigger for the deactivation (Tango to OCSG) on the endDateTime specified

Request parameters table

All parameters are mandatory.
Table 1. Deactivate Policy Parameters Table
Parameter Description

methodId

Integer that identifies the method to be executed. So, when you need to deactivate a policy rule, this is the request parameter for that.

values

  • 1 = deactivate

/sponsordata/sds/campaigns/deactivate?methodId=1

sponsorName

A string that denotes the name of the sponsor. Who is this bodacious benefactor?

/sponsordata/sds/campaigns/deactivate?methodId=1&sponsorName=sponsor

campaignId

Integer that uniquely identifies the campaign. Important stuff here!

/sponsordata/sds/campaigns/deactivate?methodId=1&sponsorName=sponsor2&campaignId=1

commandId

A mandatory parameter which represents the auto-generated ID which comes from the [Add or Activate a Policy Rule] operation response.

This is important in identifying the rule to be deactivated.

campaignName

A string that names the campaign.

campaignMetadata

A string that contains details (meta-data) about the campaign.

sponsoredIPAddressList

List of server-side IP addresses for which access is sponsored. This is comma-separated.

/sponsordata/sds/campaigns/deactivate?methodId=1&sponsorName=sponsor2&campaignId=1&sponsoredIPAddressList=127.0.0.1, 127.0.0.2


Response parameters table

Once you have deactivated a policy rule, the response will contain the parameters as outlined in the table and sample below.

Table 2. Deactivate Policy Response Table
Parameter Description

responseCode

Integer showing the result of the operation.

<div class="ulist"> <ul> <li> <p><code>0</code> = Success.</p> </li> <li> <p><code>-1</code> = Failure.</p> </li> <li> <p><code>-2</code> = The campaign already exists.</p> </li> <li> <p><code>-3</code> = An <a href="https://www.oracle.com/industries/communications/products/services-gatekeeper/" target="_blank" rel="noopener">OCSG</a> connection failure occurred</p> </li> <li> <p><code>-4</code> = Campaign expiration failure.</p> </li> <li> <p><code>-5</code> = The campaign contains invalid dates.</p> </li> <li> <p><code>-6</code> = The campaign does not exist.</p> </li> </ul> </div>

responseDescription

A text string that describes the result of the operation.

This should be used at the discretion of the external system.

commandId

An auto-generated ID that uniquely identifies the command in the system log.

Deactivate response

{
   "responseCode": "0",
   "responseDescription": "DEACTIVATE REQUEST SUCCESSFUL",
   "commandId": "18"
}