Service: QuestionnaireService
Version: 1_34 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Active version. This version can be subject to minor retro-compatible changes without warnings.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.questionnaire.v1_34.QuestionnaireService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/questionnaireService/v1_34/{methodName} Replace {methodName} for the desired method name as shown below.
To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.
For further documentation and examples, please check in Platform Website.
Methods:
assignQuestionnaireToMovement
Assign a questionnaireId to a movement.
Parameters
| questionnaireId | Long | |
| movementId | Long | |
Return value
| WebMethodResult |
|
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
clearQuestionnaireForMovement
Clear answeredQuestionnaire of a movement.
1) Delete answerQuestions.
2) Update movement before delete answeredQuestionnaire because of restriction FK_MOVEMENT_ANSWERQUESTNR.
3) Delete answeredQuestionnaire.
NOTE: I don´t delete questionnaireId from movement because questionnaire has to be associated to the movement.
Parameters
| movementId | Long | target movement ID to empty. |
Return value
WebMethodResult
filterQuestionnairesAssociatedWithCurrentSalesChannel
Method to filter out questionnaireIds that are not associated with the current Sales Channel.
Parameters
| questionnaireIds | List of Long | The list of questionnaireIds to evaluate |
Return value
| QuestionnaireIdsResult |
| Questionnaire IDs Result implementation DTO.
Contains the IDs of a list of questionnaires. May be empty if no matching questionnaires have been found. |
| questionnaireIds | List of Long | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
getExistingQuestionnaireId
Gets (if exists) the questionnaire id associated to a sales channel in a particular season that contains all of the question codes in the list.
Parameters
| salesChannelId | Long | |
| seasonId | Long | |
| questionCodes | List of String | |
Return value
| QuestionnaireIdResult |
| Questionnaire ID Result implementation DTO.
Contains the ID of a found questionnaire. May be null if no matching questionnaire has been found. |
| questionnaireId | Long | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
getQuestionnaireAnswer
Method to the answers for a questionnaire linked to the given movement.
Parameters
| ticketIds | List of Long | |
| movementIds | List of Long | |
Return value
| QuestionnaireAnswerResult |
|
| answerQuestionnaire | List of AnswerQuestionnaire | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AnswerQuestion |
|
| answerCodes | List of String | |
| questionCode | String (8) | |
| BeneficiaryInfo |
|
| beneficiaryBirthPlace | String | |
| beneficiaryBirthRegion | String | |
| beneficiaryBirthdate | Date | |
| beneficiaryCountryCode | String (8) | |
| beneficiaryFirstname | String | |
| beneficiaryIdNumber | String | |
| beneficiaryLastname | String | |
getQuestionnaireById
Method to the answers for a questionnaire linked to the given movement.
Parameters
| questionnaireIds | List of Long | |
Return value
| QuestionnairesResult |
|
| questionnaires | List of Questionnaire | |
| questions | List of Question | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| QuestionnaireQuestion |
|
| mandatoryAnswer | boolean | |
| questionId | Long | |
| rank | Integer | |
| Question |
|
| answerElements | List of AnswerElement | |
| answerType | (ADDRESS|BOOLEAN|NUMBER|
DATE|PHONE|COUNTRY|EMAIL|
TEXT|LIST_SINGLE|
LIST_MULTI) | |
| autoCopiedAnswer | boolean | |
| code | String (8) | |
| defaultAnswer | String | |
| externalDescription | ExternalName | This field is described more information about a question. - 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| internalName | ExternalName | 60 characters max for each translation |
| AnswerElement |
|
| code | String (8) | |
| defaultValue | boolean | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| internalName | ExternalName | 60 characters max for each translation |
| rank | Integer | |
| Translation |
|
| locale | String (2) | |
| value | String | |