Creates multiple demographic quota groups on a single project. This is an all or nothing operation.

Endpoint URL

http://api.clearvoicesurveys.com/api/v1/quotagroups/createquotagroups

Parameters

ProjectGuid
globally unique identifier
ClearVoice's unique identifier for the project the quota group should be created in.

Required
QuotaGroups
Collection of QuotaGroup
QuotaGroup's to be created under the supplied project.

Example Request Data

{
  "ProjectGuid": "2ae495c9-02cc-4d79-a0dd-0e877281e6cb",
  "QuotaGroups": [
    {
      "Demographics": [
        {
          "DemographicGuid": "d7dd110f-2b20-4c24-b69b-c204f87708a0",
          "Answers": [
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            },
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            }
          ]
        },
        {
          "DemographicGuid": "d7dd110f-2b20-4c24-b69b-c204f87708a0",
          "Answers": [
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            },
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            }
          ]
        }
      ],
      "AllowDynamicSurveys": true,
      "AllowExternalSuppliers": true,
      "SurveyInvitations": [
        {
          "Culture": "sample string 1",
          "EmailInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          },
          "EmailReInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          }
        },
        {
          "Culture": "sample string 1",
          "EmailInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          },
          "EmailReInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          }
        }
      ],
      "QuotaGroupName": "sample string 1",
      "RequestedCompletes": 2,
      "BidResponseRate": 3.0,
      "IncidenceRate": 4.0,
      "QuotaGroupTriggers": {
        "StartCap": 1,
        "CompleteCap": 1,
        "OverQuotaCap": 1,
        "TerminateCap": 1
      }
    },
    {
      "Demographics": [
        {
          "DemographicGuid": "d7dd110f-2b20-4c24-b69b-c204f87708a0",
          "Answers": [
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            },
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            }
          ]
        },
        {
          "DemographicGuid": "d7dd110f-2b20-4c24-b69b-c204f87708a0",
          "Answers": [
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            },
            {
              "AnswerGuid": "b0139971-a7c7-4bf6-a2ed-c28164d81f27"
            }
          ]
        }
      ],
      "AllowDynamicSurveys": true,
      "AllowExternalSuppliers": true,
      "SurveyInvitations": [
        {
          "Culture": "sample string 1",
          "EmailInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          },
          "EmailReInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          }
        },
        {
          "Culture": "sample string 1",
          "EmailInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          },
          "EmailReInvitation": {
            "Subject": "sample string 1",
            "Body": "sample string 2"
          }
        }
      ],
      "QuotaGroupName": "sample string 1",
      "RequestedCompletes": 2,
      "BidResponseRate": 3.0,
      "IncidenceRate": 4.0,
      "QuotaGroupTriggers": {
        "StartCap": 1,
        "CompleteCap": 1,
        "OverQuotaCap": 1,
        "TerminateCap": 1
      }
    }
  ]
}

Response Description

CreatedQuotaGroups
Collection of CreateQuotaGroupResponseModel
List of quota groups that were created.

Example Response

{
  "CreatedQuotaGroups": [
    {
      "ProjectGuid": "603810c5-cfbe-4ab6-9de2-9a6507fe5bf9",
      "QuotaGroupGuid": "aaf3c1d9-623d-43c2-84a1-c8d97a267abf"
    },
    {
      "ProjectGuid": "603810c5-cfbe-4ab6-9de2-9a6507fe5bf9",
      "QuotaGroupGuid": "aaf3c1d9-623d-43c2-84a1-c8d97a267abf"
    }
  ]
}