GET (List)

Lists all configured campaigns.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/campaign?summary=<true/false>

Where summary is an optional query parameter that is false by default.

OR

https://<ServerIP>:<Port>/ccp-webapp/ccp/campaign?metrics=<true/false>

Where metrics is an optional query parameter that is false by default.

HTTPS method:

GET

Example XML responses:

When summary is true and metrics is false: 


<Campaigns>
  <Campaign>
    <refURL>
       https://[ServerIP]:[Port]/ccp-webapp/ccp/
       campaign/MyTestCampaign
    </refURL>
  </Campaign>
  <Campaign>
    <refURL>
      https://[ServerIP]:[Port]/ccp-webapp/ccp/
      campaign/MyTestCampaign2
    </refURL>
  </Campaign>
</Campaigns>

When summary is false and metrics is false: 


<Campaigns>
  <Campaign>
    <refURL>
      https://[ServerIP]:[Port]/ccp-webapp/ccp/
      campaign/MyTestCampaign
    </refURL>
    <name>MyTestCampaign</name>
    <publicid>MyTestCampaign</publicid>
    <description>This is my test campaign</description>
    ...
  </Campaign>
  <Campaign>
    <refURL>
      https://[ServerIP]:[Port]/ccp-webapp/ccp/
      campaign/MyTestCampaign2
    </refURL>
    <name>MyTestCampaign2</name>
    <publicid>MyTestCampaign2</publicid>
    <description>This is my test campaign</description>
    ...
  </Campaign>
</Campaigns>

When summary is false and metrics is true: 


<Campaigns>
  <Campaign>
    <refURL>
      https://[ServerIP]:[Port]/ccp-webapp/ccp/
      campaign/MyTestCampaign
    </refURL>
    <name>MyTestCampaign</name>
    <publicid>MyTestCampaign</publicid>
    <description>This is my test campaign</description>
    <metrics>
      <socialContactCount>12</socialContactCount>
    </metrics>
    ...
  </Campaign>
  <Campaign>
    <refURL>
      https://[ServerIP]:[Port]/ccp-webapp/ccp/
      campaign/MyTestCampaign2
    </refURL>
    <name>MyTestCampaign2</name>
    <publicid>MyTestCampaign2</publicid>
    <description>This is my test campaign</description>
    <metrics>
      <socialContactCount>12</socialContactCount>
    </metrics>
    ...
  </Campaign>
</Campaigns>

Summary set to true and metrics set to true is an invalid combination.