API - Strategy

Description

These APIs are used to perform CRUD operations on the strategy.

Get All Strategies for Interactive Channel

GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies?page=0&size=50

Request Parameters

Parameters	Description	Default Values
page	number, nth page to retrieve records.	0
size	number of records per page.	50
mode	Optional, if mode = recent, API will retrieve 5 strategies that are most recently updated	None

Output

Table 1. Response Codes
Success	200	Ok
Error	400	Inputs provided for the API are not valid.
Server Error	500	Internal Server Error. For more details, check the logs.

Example response: Content-Type: application/json

{

"content": [

{
  "campaignCode": "string",
  "campaignId": 0,
  "campaignName": "string",
  "createBy": "string",
  "createDate": 0,
  "deleteLock": 0,
  "description": "string",
  "editLock": 0,
  "id": 0,
  "interactiveChannelId": 0,
  "interactiveChannelName": "string",
  "lastProdDepTime": 0,
  "name": "string",
  "ruleCount": 0,
  "runEnable": 0,
  "updateBy": "string",
  "updateDate": 0

}
 
],

"page": {

"pageNumber": 0,

"totalElements": 0,

"totalPages": 0,

"size": 0,

"hasNext": false,

"hasPrev": false

}

}

Get Strategy by Strategy Id or Name

GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}

Output

Table 2. Response Codes
Success	200	Ok
Error	400	Inputs provided for the API are not valid.
Server Error	500	Internal Server Error. For more details, check the logs.

Example: Content-Type: application/json

{
  "campaignCode": "string",
  "campaignId": 0,
  "campaignName": "string",
  "createBy": "string",
  "createDate": 0,
  "deleteLock": 0,
  "description": "string",
  "editLock": 0,
  "id": 0,
  "interactiveChannelId": 0,
  "interactiveChannelName": "string",
  "lastProdDepTime": 0,
  "name": "string",
  "ruleCount": 0,
  "runEnable": 0,
  "updateBy": "string",
  "updateDate": 0

}

Create Strategy

POST /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies

Input

Body Parameter – Content-Type:application/json

{
  "campaignId": 0,
  "description": "string",
  "name": "string",
  
}

Output

Table 3. Response Codes
Success	201	Created
Error	400	Bad Request
Server Error	500	Internal /Server Error.

Example: Content-Type: application/json

{
  "campaignCode": "string",
  "campaignId": 0,
  "campaignName": "string",
  "createBy": "string",
  "createDate": 0,
  "deleteLock": 0,
  "description": "string",
  "editLock": 0,
  "id": 0,
  "interactiveChannelId": 0,
  "interactiveChannelName": "string",
  "lastProdDepTime": 0,
  "name": "string",
  "ruleCount": 0,
  "runEnable": 0,
  "updateBy": "string",
  "updateDate": 0

}

Update

PUT /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}

Input

Body Parameter – Content-Type:application/json

{
  				"campaignId": 0,  				
  				"description": "string",  				
  				"id": 0,  				
  				"name": "string", 				
  				

}

Output

Table 4. Response Codes
Success	202	Accepted
Error	400	Bad Request
Server Error	500	Internal /Server Error.

{
  "campaignCode": "string",
  "campaignId": 0,
  "campaignName": "string",
  "createBy": "string",
  "createDate": 0,
  "deleteLock": 0,
  "description": "string",
  "editLock": 0,
  "id": 0,
  "interactiveChannelId": 0,
  "interactiveChannelName": "string",
  "lastProdDepTime": 0,
  "name": "string",
  "ruleCount": 0,
  "runEnable": 0,
  "updateBy": "string",
  "updateDate": 0

}

Delete

DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}

Output

Table 5. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal /Server Error.

Copy Strategy

POST /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}

Input

Body Parameter – Content-Type:application/json

{			
  				"campaignId": 0,
  				"name": "string",
  				"description": "string", 				
  				
}

Output

Table 6. Response Codes
Success	202	Accepted
Error	400	Bad Request
Server Error	500	Internal /Server Error.

{
  "campaignCode": "string",
  "campaignId": 0,
  "campaignName": "string",
  "createBy": "string",
  "createDate": 0,
  "deleteLock": 0,
  "description": "string",
  "editLock": 0,
  "id": 0,
  "interactiveChannelId": 0,
  "interactiveChannelName": "string",
  "lastProdDepTime": 0,
  "name": "string",
  "ruleCount": 0,
  "runEnable": 0,
  "updateBy": "string",
  "updateDate": 0

}