Skip to main content

Get quota response

meta objectrequired
httpStatusHttp status code (string)required

HTTP status code.

requestIdrequestId (string)required

The unique identifier of the associated request.

noticeAn informational string about the request. (string)

Additional information about this response.

result objectrequired

Keep track of how many respondents meet a condition in the survey

Namestringrequired

Quota Name

Occurrencesintegerrequired

Quota Limit. Default: 100

Countinteger

Quota Count. Default: 0

CountForUndointeger

For restoring quota count

Logic objectrequired

Logic of when to increment the quota

oneOf
object
LogicType object

One of Simple or Cross Logic Quota

oneOf
string

Possible values: [Simple, Cross]

QuotaActionQuotaAction (string)required

Specify the action to take once the quota has been met for the respondent. Default: EndCurrentSurvey. See ActionInfo and ActionElement

Possible values: [EndCurrentSurvey, DontDisplaySurvey, DontDisplayQuestion, DontDisplayBlock, CallWebService, ForBranching, SiteIntercept]

ActionElement object

The element corresponding to the QuotaAction when QuotaAction is one of DontDisplaySurvey, DontDisplayQuestion, or DontDisplayBlock. See QuotaAction

anyOf
Survey Id (string)

The unique identifier for this survey.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

ActionInfo object

Additional info for QuotaAction. See QuotaAction

property name*any

Additional info for QuotaAction. See QuotaAction

ActionLogic object

Additional info for QuotaAction. See QuotaAction

property name*any

Additional info for QuotaAction. See QuotaAction

IDQuota Id (string)required

The unique identifier for the quota.

Possible values: Value must match regular expression ^QO_[0-9a-zA-Z]{11,15}$

QuotaRealmstringrequired

One of Survey or ResponseSet

Possible values: [Survey, ResponseSet]

QuotaSchedule object
oneOf
QuotaStartstringrequired

Possible values: Value must match regular expression ^(20[0-9][0-9])-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

QuotaPeriodLengthQuotaPeriodLength (integer)required

Possible values: >= 0 and <= 1000

QuotaNumPeriodsQuotaPeriodLength (integer)required

Possible values: >= 0 and <= 1000

StartTimezoneTimeZone (string)

Possible values: [Africa/Bangui, Africa/Harare, Africa/Nairobi, America/Anchorage, America/Argentina/Buenos_Aires, America/Chicago, America/Denver, America/La_Paz, America/Los_Angeles, America/Montevideo, America/New_York, America/Noronha, America/Phoenix, America/Rio_Branco, Asia/Baku, Asia/Bangkok, Asia/Calcutta, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Kabul, Asia/Karachi, Asia/Katmandu, Asia/Krasnoyarsk, Asia/Tehran, Asia/Magadan, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Seoul, Asia/Yakutsk, Asia/Yekaterinburg, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/Reykjavik, Australia/Adelaide, Australia/Brisbane, Australia/Canberra, Australia/Darwin, Canada/Atlantic, Canada/East-Saskatchewan, Canada/Newfoundland, Europe/Athens, Europe/Berlin, Europe/London, Europe/Moscow, Pacific/Auckland, Pacific/Fiji, Pacific/Honolulu, Pacific/Midway, Pacific/Tongatapu]

QuotaCountsinteger[]
EndSurveyOptions object
EndingTypestringrequired

Whether to use the default ending options or advanced (custom)

Possible values: [Default, Advanced]

ResponseFlagstring

How to mark the response. Default QuotaMet

Possible values: [QuotaMet]

SurveyTerminationSurveyTermination (string)nullable

End of survey action such as showing respondents a response summary. See EOSMessageLibrary, EOSMessage, ResponseSummary, and EOSRedirectURL.

Possible values: [DefaultMessage, DisplayMessage, DisplayResult, ResponseSummary, Redirect]

Default value: DefaultMessage
EOSRedirectURLEOSRedirectURL (string)

The URL to redirect respondents to at the end of the survey used when SurveyTermination is set to Redirect.

EOSMessageLibraryEOSMessageLibrary (string)

End of survey message library used when SurveyTermination is set to DisplayMessage. See SurveyTermination and EOSMessage.

EOSMessageEnd of Survey Message (string)nullable

ID of the message to be displayed at the end of the survey

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345
EmailThankYouEmailThankYou (string)

Send an email thank you message after survey completion

Possible values: [true, false]

Default value: false
ThankYouEmailMessageLibraryThankYouEmailMessageLibrary (string)

Library ID associated with the Message ID in ThankYouEmailMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001
ThankYouEmailMessageThankYouEmailMessage (string)nullable

ID of the library message to use for the thank you email. See EmailThankYou and ThankYouEmailMessage.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345
ResponseSummaryResponseSummary (string)

Shows the response summary at the end of the survey used when SurveyTermination is set to ResponseSummary.

Possible values: [Yes, No]

Default value: No
ConfirmResponseSummarystring

Show response summary before completing the survey

Possible values: [Yes, ``]

ConfirmMessageLibraryMessageLibraryID (string)

The unique identifier for the message library.

Possible values: Value must match regular expression ^ML_[a-zA-Z0-9]{11,15}$

ConfirmMessageMessage Id (string)

The unique identifier for the message.

Possible values: Value must match regular expression ^MS_[a-zA-Z0-9]{11,15}$

CountQuotasYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

ScreenoutYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

ScreenOutNamestring
AnonymizeResponseYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

IgnoreResponseYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

WebServiceOptions object
urlstring<uri-reference>required

The HTTP URL of a string.

Possible values: Value must match regular expression https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)

params object[]required

Possible values: <= 1000

  • Array [
    • keystringrequired
    valuestringrequired
  • ]
    • CrossLogicDef object[]

    Definition for the cross logic quota

  • Array [
    • Occurrencesnumberrequired
    Descriptionstringrequired
    IDintegerrequired

    Possible values: >= 0 and <= 1000

    Logic objectrequired
    property name*any
    Countinteger
    OverrideOccurrencesinteger
  • ]
    • PerformActionOnUserPerformActionOnUser (boolean)
    Get quota response
    {
      "meta": {
        "httpStatus": "string",
        "requestId": "string",
        "notice": "string"
      },
      "result": {
        "Name": "string",
        "Occurrences": 0,
        "Count": 0,
        "CountForUndo": 0,
        "Logic": {},
        "LogicType": "Simple",
        "QuotaAction": "EndCurrentSurvey",
        "ActionElement": "string",
        "ActionInfo": {},
        "ActionLogic": {},
        "ID": "string",
        "QuotaRealm": "Survey",
        "QuotaSchedule": {
          "QuotaStart": "string",
          "QuotaPeriodLength": 0,
          "QuotaNumPeriods": 0,
          "StartTimezone": "Africa/Bangui",
          "QuotaCounts": [
            0
          ]
        },
        "EndSurveyOptions": {
          "EndingType": "Default",
          "ResponseFlag": "QuotaMet",
          "SurveyTermination": "DefaultMessage",
          "EOSRedirectURL": "string",
          "EOSMessageLibrary": "string",
          "EOSMessage": "MS_abcdefg12345",
          "EmailThankYou": "false",
          "ThankYouEmailMessageLibrary": "UR_SomeUserId001",
          "ThankYouEmailMessage": "MS_abcdefg12345",
          "ResponseSummary": "No",
          "ConfirmResponseSummary": "Yes",
          "ConfirmMessageLibrary": "string",
          "ConfirmMessage": "string",
          "CountQuotas": "Yes",
          "Screenout": "Yes",
          "ScreenOutName": "string",
          "AnonymizeResponse": "Yes",
          "IgnoreResponse": "Yes"
        },
        "WebServiceOptions": {
          "url": "string",
          "params": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        },
        "CrossLogicDef": [
          {
            "Occurrences": 0,
            "Description": "string",
            "ID": 0,
            "Logic": {},
            "Count": 0,
            "OverrideOccurrences": 0
          }
        ],
        "PerformActionOnUser": true
      }
    }