Planning

Campaign Planning Service APIs

Facilitates planning of campaigns.

Submit a Campaign Plan.

post

Submits a Planning Request Ok response is returned.

Body

The request object, containing all necessary information for creating an planning request and the request body metadata

Responses

200

Plan created successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /planning/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "planning": {
    "tenantId": "text",
    "url": "https://fileserver.com/uuid",
    "level": "province",
    "value": "SOLIMBO"
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "planning": {
    "tenantId": "text",
    "completed": 12,
    "failed": 1,
    "errorRowsURL": "https://fileserver.com/uuid"
  }
}

Create Campaign Plan Template.

post

Search Template Ok response is returned.

Body

The request object, containing all necessary information for creating an planning template request and the request body metadata

Responses

200

Template Created.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /planning/template/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "planning": {
    "tenantId": "text",
    "level": "province",
    "value": "SOLIMBO"
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "planning": {
    "tenantId": "text",
    "templateUrl": "https://fileserver.com/uuid"
  }
}