CheckWare partner API reference guide

Webservice operations

OverviewDatatypesWebservice operationsChangelog

addRespondent

Add a new respondent to the system. If no treatment is defined, the treatment type defined as default will be used and automatically added. Specific treatment types can be added, included roles and attributes. If default treatment contains mandatory attributes or roles, the client must ensure that these are always populated in the request.

Input

addRespondentRequest
PartTypeDescription
addRespondentRequestrespondentThe respondent to be added.
Respondent ID could be defined by client or automatically set by application. The way of setting respondent ID depends of configuration.
If respondent ID is set by application, value of respondentID parameter should be empty in addRespondent operation.
Respondent ID must be unique number if set by client.
addRespondentSendPasswordSMSbooleanIf this paramenter is set to "true" an SMS will be sent to the respondent's
mobile number containing the submitted password.

Output

addRespondentResponse
PartTypeDescription
addRespondentResponserespondentIDThe respondenID for the newly added respondent (only on success).

Use this value to identifiy the respondent later on.