API – Zone and Interaction Point wrapper
- Description
- These APIs are used to perform CRUD operations on zones and interaction points.
- Get All
- GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones?page=0&size=10
- Parameters
-
Parameters Default value page 0 size 10 - Output
-
Table 1. Response Codes Success 200 Ok Error 400 Bad Request Server Error 500 Internal/Server Error - Example: Content-Type: application/json
- Get
- GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones/{zoneIdOrName}
- Output
-
Table 2. Response Codes Success 200 Ok Error 400 Bad Request Server Error 500 Internal/Server Error - Example: Content-Type: application/json
- Create
- POST /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones
- Input
- Body Parameter – Content-Type: application/json
- Output
-
Table 3. Response Codes Success 201 Created Miscellaneous 207 Status code for batch request Error 400 Bad request Server Error 500 Internal server error - Example: Content-Type: application/json
- Update
- PUT /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones/{zoneName}
- Input
- Body Parameter – Content-Type: application/json
- Output
-
Table 4. Response Codes Success 202 Accepted Error 400 Bad Request Server Error 500 Internal/Server Error - Example: Content-Type: application/json
- Delete
- DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones/{zoneName}
- Input
-
Query Parameters onlyIP: true/false Delete only IPs from zone - Input IDs
-
{"ids":[0]}
- Output
-
Table 5. Response Codes Success 204 No Content Error 400 Bad Request Server Error 500 Internal/Server Error - Delete Multiple
- DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/zones
- Input
- Body Parameter – Content-Type: application/json
- Output
-
Table 6. Response Codes Success 204 No Content Error 400 Bad Request Server Error 500 Internal/Server Error