Campaign

Campaign Service APIs

Facilitates campaign management - create, update, search or schedule campaigns.

Create a campaign.

Create's a campaign. On successful campaign creation, Ok response is returned.

post

/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignobject

A representation of Campaign.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaign": {
    "id": "CAMPAIGN-ID-1",
    "tenantId": "tenantA",
    "name": "LLIN 2022",
    "type": "LLIN",
    "eligibilityCriteria": "INSTRUCTIONS",
    "isRegistrationAndDeliveryCombined": true,
    "startDate": 1663218161,
    "endDate": 1663218161,
    "deliveryProcedure": "INSTRUCTIONS",
    "additionalFields": {},
    "disease": "MALARIA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "beneficiaryType": "HOUSEHOLD",
    "deliveryStrategy": "FIXED",
    "status": "CREATED",
    "campaignSchedules": [
      {
        "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
        "campaignId": "1",
        "startDate": "EPOCH",
        "endDate": "EPOCH",
        "noOfRounds": 4,
        "durationBetweenRounds": 30,
        "isRecurring": true,
        "recurringFrequency": 4,
        "durationAndFrequencyUnit": "DAYS",
        "additionalFields": {},
        "tenantId": "tenantA",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "campaignRounds": [
      {
        "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
        "campaignId": "1",
        "startDate": "EPOCH",
        "endDate": "EPOCH",
        "status": "INPROGRESS",
        "boundaryId": "ID",
        "additionalFields": {},
        "tenantId": "tenantA",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "desiredTargets": {
          "desiredTeamTarget": 100,
          "desiredCoverageTarget": 0.8,
          "desiredPopulationTarget": 1000
        },
        "achievedTargets": {
          "achievedTeamTarget": 100,
          "achievedCoverageTarget": 0.8,
          "achievedPopulationTarget": 1000
        }
      }
    ]
  }
}

Campaign created successfully.

Update A Campaign.

Update A Campaign, Ok response is returned.

post

/v1/_update

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaign": {
    "id": "CAMPAIGN-ID-1",
    "tenantId": "tenantA",
    "name": "LLIN 2022",
    "type": "LLIN",
    "eligibilityCriteria": "INSTRUCTIONS",
    "isRegistrationAndDeliveryCombined": true,
    "startDate": 1663218161,
    "endDate": 1663218161,
    "deliveryProcedure": "INSTRUCTIONS",
    "additionalFields": {},
    "disease": "MALARIA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "beneficiaryType": "HOUSEHOLD",
    "deliveryStrategy": "FIXED",
    "status": "CREATED",
    "campaignSchedules": [
      {
        "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
        "campaignId": "1",
        "startDate": "EPOCH",
        "endDate": "EPOCH",
        "noOfRounds": 4,
        "durationBetweenRounds": 30,
        "isRecurring": true,
        "recurringFrequency": 4,
        "durationAndFrequencyUnit": "DAYS",
        "additionalFields": {},
        "tenantId": "tenantA",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "campaignRounds": [
      {
        "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
        "campaignId": "1",
        "startDate": "EPOCH",
        "endDate": "EPOCH",
        "status": "INPROGRESS",
        "boundaryId": "ID",
        "additionalFields": {},
        "tenantId": "tenantA",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "desiredTargets": {
          "desiredTeamTarget": 100,
          "desiredCoverageTarget": 0.8,
          "desiredPopulationTarget": 1000
        },
        "achievedTargets": {
          "achievedTeamTarget": 100,
          "achievedCoverageTarget": 0.8,
          "achievedPopulationTarget": 1000
        }
      }
    ]
  }
}

Updated campaign successfully.

Search Campaigns.

Search Campaigns Ok response is returned.

post

/v1/_search

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignSearchCriteriaobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 1,
  "campaigns": [
    {
      "id": "CAMPAIGN-ID-1",
      "tenantId": "tenantA",
      "name": "LLIN 2022",
      "type": "LLIN",
      "eligibilityCriteria": "INSTRUCTIONS",
      "isRegistrationAndDeliveryCombined": true,
      "startDate": 1663218161,
      "endDate": 1663218161,
      "deliveryProcedure": "INSTRUCTIONS",
      "additionalFields": {},
      "disease": "MALARIA",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "beneficiaryType": "HOUSEHOLD",
      "deliveryStrategy": "FIXED",
      "status": "CREATED",
      "campaignSchedules": [
        {
          "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
          "campaignId": "1",
          "startDate": "EPOCH",
          "endDate": "EPOCH",
          "noOfRounds": 4,
          "durationBetweenRounds": 30,
          "isRecurring": true,
          "recurringFrequency": 4,
          "durationAndFrequencyUnit": "DAYS",
          "additionalFields": {},
          "tenantId": "tenantA",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "campaignRounds": [
        {
          "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
          "campaignId": "1",
          "startDate": "EPOCH",
          "endDate": "EPOCH",
          "status": "INPROGRESS",
          "boundaryId": "ID",
          "additionalFields": {},
          "tenantId": "tenantA",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "desiredTargets": {
            "desiredTeamTarget": 100,
            "desiredCoverageTarget": 0.8,
            "desiredPopulationTarget": 1000
          },
          "achievedTargets": {
            "achievedTeamTarget": 100,
            "achievedCoverageTarget": 0.8,
            "achievedPopulationTarget": 1000
          }
        }
      ]
    }
  ]
}

Fetched Search Campaigns.

Create a campaign schedule.

Create's a campaign schedule. On successful campaign schedule creation, Ok response is returned.

post

/schedule/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignScheduleobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/schedule/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaignRound": {
    "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
    "campaignId": "1",
    "startDate": "EPOCH",
    "endDate": "EPOCH",
    "noOfRounds": 4,
    "durationBetweenRounds": 30,
    "isRecurring": true,
    "recurringFrequency": 4,
    "durationAndFrequencyUnit": "DAYS",
    "additionalFields": {},
    "tenantId": "tenantA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Campaign schedule created successfully.

Update A Campaign schedule.

Update A Campaign, schedule Ok response is returned.

post

/schedule/v1/_update

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignScheduleall ofrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/schedule/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaignRound": {
    "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
    "campaignId": "1",
    "startDate": "EPOCH",
    "endDate": "EPOCH",
    "noOfRounds": 4,
    "durationBetweenRounds": 30,
    "isRecurring": true,
    "recurringFrequency": 4,
    "durationAndFrequencyUnit": "DAYS",
    "additionalFields": {},
    "tenantId": "tenantA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Updated campaign schedule successfully.

Search Campaigns.

Search Campaigns schedule Ok response is returned.

post

/schedule/v1/_search

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignScheduleSearchCriteriaobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/schedule/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 1,
  "campaignRounds": [
    {
      "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1",
      "campaignId": "1",
      "startDate": "EPOCH",
      "endDate": "EPOCH",
      "noOfRounds": 4,
      "durationBetweenRounds": 30,
      "isRecurring": true,
      "recurringFrequency": 4,
      "durationAndFrequencyUnit": "DAYS",
      "additionalFields": {},
      "tenantId": "tenantA",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Fetched Search Campaign schedule.

Create a campaign rounds.

Create's a campaign round. On successful campaign round creation, Ok response is returned.

post

/rounds/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignRoundobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/rounds/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaignRound": {
    "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
    "campaignId": "1",
    "startDate": "EPOCH",
    "endDate": "EPOCH",
    "status": "INPROGRESS",
    "boundaryId": "ID",
    "additionalFields": {},
    "tenantId": "tenantA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "desiredTargets": {
      "desiredTeamTarget": 100,
      "desiredCoverageTarget": 0.8,
      "desiredPopulationTarget": 1000
    },
    "achievedTargets": {
      "achievedTeamTarget": 100,
      "achievedCoverageTarget": 0.8,
      "achievedPopulationTarget": 1000
    }
  }
}

Campaign round created successfully.

Update A Campaign rounds.

Update A Campaign round Ok response is returned.

post

/rounds/v1/_update

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignRoundall ofrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/rounds/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "campaignRound": {
    "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
    "campaignId": "1",
    "startDate": "EPOCH",
    "endDate": "EPOCH",
    "status": "INPROGRESS",
    "boundaryId": "ID",
    "additionalFields": {},
    "tenantId": "tenantA",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "desiredTargets": {
      "desiredTeamTarget": 100,
      "desiredCoverageTarget": 0.8,
      "desiredPopulationTarget": 1000
    },
    "achievedTargets": {
      "achievedTeamTarget": 100,
      "achievedCoverageTarget": 0.8,
      "achievedPopulationTarget": 1000
    }
  }
}

Updated campaign round successfully.

Search Campaign rounds.

Search Campaign rounds schedule Ok response is returned.

post

/rounds/v1/_search

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

campaignSearchCriteriaobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/campaigns/rounds/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 1,
  "campaignRounds": [
    {
      "campaignRoundId": "CAMPAIGN-ROUND-ID-1",
      "campaignId": "1",
      "startDate": "EPOCH",
      "endDate": "EPOCH",
      "status": "INPROGRESS",
      "boundaryId": "ID",
      "additionalFields": {},
      "tenantId": "tenantA",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "desiredTargets": {
        "desiredTeamTarget": 100,
        "desiredCoverageTarget": 0.8,
        "desiredPopulationTarget": 1000
      },
      "achievedTargets": {
        "achievedTeamTarget": 100,
        "achievedCoverageTarget": 0.8,
        "achievedPopulationTarget": 1000
      }
    }
  ]
}

Fetched Search Campaign rounds.