CreateConsumersRequest
Creates multiple people in a list and adds authentication info if requested. Shared fields between membership and interaction will be synched up only if an interaction record is created. NOTE: Indexes must match across all arrays passed in.
Properties
Name | Type | Required | Description |
---|---|---|---|
List | ListIdentifier | Required | |
ConsumerBulkData | ConsumerBulkData | Required |
Exceptions
Exception | Severity | Code | Condition |
---|---|---|---|
ArgumentMissing | Critical | 10010001 | A required request input has not been specified. |
IdentifierDoesNotExist | Critical | 10010002 | Specified identifier does not exist. |
MultipleRecordsFound | Critical | 10010004 | Multiple records were found when only one was expected. |
ArgumentOutOfRange | Critical | 10010008 | Optional data array length must match PeopleData array length. |
DuplicateInputFound | Critical | 10010015 | Duplicate input was found. |
ArgumentExceedsSizeLimit | Critical | 10010018 | BulkData array cannot exceed 500 records. |
UserAlreadyExists | Critical | 10020006 | The username specified for the person identifier already exists. |
QuestionIdNotValid | Critical | 10020014 | The QuestionId is not valid. |
ClientKeyAlreadyExists | Critical | 10040003 | Client Key already exists in client. |
AccessCodeAlreadyExists | Critical | 10050001 | Access code already exists in this list. |
NoAvailableAccessCodes | Critical | 10050008 | No access codes can be assigned because all possible access codes have been used. |
LanguageIsoCodeIsInvalid | Critical | 10070001 | ISO Code is Not Valid. |
UserNotUpdated | NonCritical | 10020013 | Provided information does not match existing information, update unsuccessful. |
ClientKeyNotUpdated | NonCritical | 10040002 | Client key value does not match existing client key value, client key not updated. |
Examples
The following is an XML example of the CreateConsumersRequest sent to the Consumers.CreateMany method.
<soapenv:Envelope xmlns:ns="http://schemas.gallup.com/oms/2010/10/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns:CreateMany xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ns:request i:type="a:CreateConsumersRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/Consumer"> <a:List i:type="b:ListIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers"> <b:ListId>1234</b:ListId> </a:List> <a:ConsumerBulkData i:nil="true" xmlns:b="http://schemas.gallup.com/oms/2010/10/Models" /> </ns:request> </ns:CreateMany> </soapenv:Body> </soapenv:Envelope>