POST api/campaigns/selectsummaries

Retrieves a list of campaign summaries that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter campaigns by.

TemplateCampaignFilterCriteriaDto
NameDescriptionTypeAdditional information
Ids

Collection of globally unique identifier

None.

TemplateId

globally unique identifier

None.

Status

TemplateCampaignStatusDto

None.

UserId

globally unique identifier

None.

OrderId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "Ids": [
    "63894a85-1be2-48b0-814a-8209923dd7ef",
    "4552e803-b05d-4861-81fd-6628dd279a60"
  ],
  "TemplateId": "f45b0c71-b395-46af-9df8-c7203dc1d8d8",
  "Status": 0,
  "UserId": "0a96e421-6026-4fd0-a88a-e1481804bb33",
  "OrderId": "1f5aaec8-9fd9-430e-a070-4bcf796e7d0b"
}

application/xml, text/xml

Sample:
<TemplateCampaignFilterCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>63894a85-1be2-48b0-814a-8209923dd7ef</d2p1:guid>
    <d2p1:guid>4552e803-b05d-4861-81fd-6628dd279a60</d2p1:guid>
  </Ids>
  <OrderId>1f5aaec8-9fd9-430e-a070-4bcf796e7d0b</OrderId>
  <Status>Created</Status>
  <TemplateId>f45b0c71-b395-46af-9df8-c7203dc1d8d8</TemplateId>
  <UserId>0a96e421-6026-4fd0-a88a-e1481804bb33</UserId>
</TemplateCampaignFilterCriteriaDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TemplateCampaignFilterCriteriaDto'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.