Campaign

1. Create Campaign

Request

Method

URL

Post

/api/campaign

Body

{
    "name": "string",
    "clusters": [
        {
            "cluster_name": "string",
            "capacity": "int",
            "weightage": "int",
            "gateways": [
                {
                    "name": "string",
                    "did_range": "string"
                }
            ]
        }
    ]
}

Response

200
{
         "status_code": int,
         "status": string
}

2. Update Campaign

Request

Method

URL

PUT

/api/campaign

Body

{
    "name": "string",
    "clusters": [
        {
            "cluster_name": "string",
            "capacity": "int",
            "weightage": "int",
            "gateways": [
                {
                    "name": "string",
                    "did_range": "string"
                }
            ]
        }
    ]
}

Response

200
{
     "status_code": int,
     "status": string
}

3. Delete Campaign

Request

Method

URL

DELETE

/api/campaign

Body

"data" : {
      "name" : string
 }

Response

200
{
     "status_code": int,
     "status": string
}

4. Get all campaigns

Request

Method

URL

GET

/api/campaign-list

Response

200
{
  "status_code": "int",
  "data": [
        {
           "name": "string",
           "clusters": [
              {
                    "cluster_name": "string",
                    "capacity": "int",
                    "weightage": "int",
                    "gateways": [
                       {
                          "name": "string",
                          "did_range": "string"
                       }
                    ]
              }
           ]
        }
  ]
}

5. Get Campaign

Request

Method

URL

GET

/api/campaign/{id}

Path Parameters

Params

Values

id

string

Response

200
{
   "status_code": int,
   "data": {
      "name": string,
      "clusters": [
         {
            "cluster_name": string,
               "capacity": int,
               "weightage": int,
            "gateways": [
               {
                  "name": string,
                  "did_range": string
               }
            ]
         }
      ]
   }
}