Receba respostas de pesquisas | Manual de integração da API do ASMS (v9)

Español

English

Português

Esse endpoint retorna a definição de uma pesquisa (perguntas e opções de resposta), as informações gerais da pesquisa e, opcionalmente, as respostas registradas pelo usuário que respondeu. A pesquisa é identificada por seu token, obtido através do endpoint Obtenha Tokens de Pesquisa.

Detalhes da petição

URL base: {host}/ASMSAPI/
Uri: /api/v9/survey/response/?token={token}
Tipo: POST
Títulos obrigatórios:
tipo de conteúdo: application/json
Autorização X: Portador {token}

Descrição do URL

{host}: Ele representa o domínio do ambiente no qual a API está localizada.
ASMSAPI/: Prefixo de API fixo.
URI: Ponto de extremidade específico para a solicitação.

⚐ URL DE EXEMPLO:

https://{host}/ASMSAPI/api/v9/survey/response/?token={token}

Parâmetros

Nome	Tipo de dado	Obrigatório	Descrição
Símbolo	Texto	Sim	Ficha do levantamento a ser consultada, obtida por Obtenha Tokens de Pesquisa

Corpo da petição

true

Responder

{

      "Answers": [

            {

                  "Id": 90,

                  "QuestionId": 7,

                  "ResponseChoiceId": 3,

                  "ResponseValue": null,

                  "token": "1077a718-fb20-463e-94d4-8581362269c9"

            },

            {

                  "Id": 92,

                  "QuestionId": 11,

                  "ResponseChoiceId": 0,

                  "ResponseValue": "Todo ok",

                  "token": "1077a718-fb20-463e-94d4-8581362269c9"

            }

      ],

      "DataConcept": "10920",

      "Questions": [

            {

                  "CreatedBy": 1,

                  "CreationDate": "/Date(1680215420753+0000)/",

                  "HelpText": "¿Esta de acuerdo con la solución del caso?",

                  "Id": 7,

                  "IsDeleted": false,

                  "IsIncludedToReport": false,

                  "IsJustificationMandatory": false,

                  "IsJustificationRequired": false,

                  "IsMandatory": false,

                  "JustificationLabel": null,

                  "MaxValue": 0,

                  "ModificationDate": null,

                  "ModifiedBy": 1,

                  "QuestionOrder": 1,

                  "QuestionTypeCode": 3,

                  "QuestionTypeId": 3,

                  "ResponseChoices": [

                        {

                              "Id": 3,

                              "IsChoiceMandatory": false,

                              "QuestionId": 7,

                              "ResponseOrder": 0,

                              "Text": "Si"

                        },

                        {

                              "Id": 4,

                              "IsChoiceMandatory": false,

                              "QuestionId": 7,

                              "ResponseOrder": 0,

                              "Text": "No"

                        }

                  ],

                  "SurveyId": 3,

                  "Title": "¿Esta de acuerdo con la solución del caso?"

            }

      ],

      "Survey": {

            "ApplicationId": 13,

            "CategoryId": 8,

            "CompanyId": null,

            "ConceptId": null,

            "CreatedBy": 1,

            "CreationDate": "/Date(1680215311867+0000)/",

            "DeactivationReason": null,

            "Description": "Encuestas RQ",

            "EndDate": null,

            "ExitPage": null,

            "Id": 3,

            "IsActive": true,

            "IsAnswered": true,

            "IsDefaultSatisfactionLevel": false,

            "ModificationDate": "/Date(1753289971717+0000)/",

            "ModifiedBy": 1,

            "Name": "Encuestas RQ",

            "Observations": null,

            "ProjectId": null,

            "Questions": null,

            "SatisfactionLevel": null,

            "StartDate": null,

            "Status": 2,

            "Title": "Encuestas RQ"

      }

}

Parâmetros de resposta

Nome	Tipo de dado	Descrição
Respostas	Lista	Lista de respostas registradas pelo usuário para a pesquisa
DataConcept	Texto	Identificador do caso (item) no qual a pesquisa foi respondida
Perguntas	Lista	Lista de perguntas que compõem a pesquisa
Levantamento	Objeto	Visão Geral da Pesquisa

Respostas

Nome	Tipo de dado	Descrição
Id	Número	ID de resposta
QuestionId	Número	Identificador da pergunta associada à resposta
RespostaEscolhaIdId	Número	Identificador da opção de resposta selecionada (aplica-se a perguntas de seleção)
ResponseValue	Texto	Valor da resposta como texto livre (aplica-se a perguntas que não envolvem seleção)
Símbolo	Texto	Token de Pesquisa

Perguntas

Nome	Tipo de dado	Descrição
Id	Número	ID da Pergunta
TextoAjuda	Texto	Texto da pergunta
Título	Texto	Título da pergunta
Ordem das Perguntas	Número	Ordem da pergunta dentro da pesquisa
QuestionTypeId	Número	Identificador do tipo de pergunta
QuestionTypeCode	Número	Código do tipo de pergunta
SurveyId	Número	ID de pesquisa ao qual a pergunta pertence
RespostaEscolhas	Lista	Lista de opções de resposta disponíveis para a pergunta (veja abaixo)
ÉObrigatório	Booleano	Indique se a pergunta é necessária
ÉJustificaçãoNecessária	Booleano	Indica se a pergunta requer justificativa
A Justificativa é Obrigatória	Booleano	Indique se a justificativa da pergunta é obrigatória
JustificaçãoRótulo	Texto	Rótulo exibido para o campo de justificação
IsIncluídoParaReportar	Booleano	Indica se a pergunta está incluída nos relatórios
IsDeleted	Booleano	Indique se a pergunta foi deletada
MaxValue	Número	Valor máximo permitido para a resposta, dependendo do tipo de pergunta
Criado por	Número	Identificador do usuário que criou a pergunta
ModificadoPor	Número	Identificador do usuário que modificou a pergunta
Data de Criação	Número (Tempo UNIX em milissegundos)	Data de criação da pergunta
Data de modificação	Número (Tempo UNIX em milissegundos)	Pergunta Data de Última Modificação

RespostaEscolhas

Nome	Tipo de dado	Descrição
Id	Número	ID da Escolha da Resposta
QuestionId	Número	Identificador da pergunta à qual a opção pertence
Texto	Texto	Texto da opção de resposta
Resposta Ordem	Número	Ordem da opção dentro da pergunta
ÉEscolhaObrigatória	Booleano	Indica se a seleção dessa opção requer uma justificativa

Levantamento

Nome	Tipo de dado	Descrição
Id	Número	ID da pesquisa
Nome	Texto	Nome da pesquisa
Título	Texto	Título da Pesquisa
Descrição	Texto	Descrição da pesquisa
IsActive	Booleano	Indica se a pesquisa está ativa
ÉRespondido	Booleano	Indica se a pesquisa já foi respondida
Estado	Número	Identificador de status da pesquisa
ApplicationId	Número	Identificador do aplicativo ao qual a pesquisa pertence
ID da categoria	Número	Identificador da categoria da pesquisa
ID da empresa	Número	Identificador da empresa associada à pesquisa, se aplicável
ConceptId	Número	Identificador do conceito associado à pesquisa, se aplicável
ID do projeto	Número	ID do projeto associado à pesquisa, se aplicável
IsDefaultSatisfactionLevel	Booleano	Indica se a pesquisa usa o nível padrão de satisfação
SatisfactionLevel	Número	Nível de satisfação configurado para a pesquisa, se aplicável
Observações	Texto	Observações registradas na pesquisa
SaídaPage	Texto	URL de redirecionamento ao concluir a pesquisa, se configurada
Data de Início	Número (Tempo UNIX em milissegundos)	Data de Vigência da Pesquisa
Data de Fim	Número (Tempo UNIX em milissegundos)	Data de Término da Pesquisa
Motivo da desativação	Texto	Motivo para desativar a pesquisa, se aplicável
Criado por	Número	Identificador do usuário que criou a pesquisa
ModificadoPor	Número	Identificador do usuário que modificou a pesquisa
Data de Criação	Número (Tempo UNIX em milissegundos)	Data de criação da pesquisa
Data de modificação	Número (Tempo UNIX em milissegundos)	Data da Última Modificação do Levantamento
Perguntas	Lista	Ele não é preenchido nesta resposta (as perguntas são retornadas no nível raiz `Questions`)

Mensagens de erro

Código	Status HTTP	Mensagem de erro
400	Solicitação BadRequest	ERROR_GETTING_SURVEY (token inexistente ou inválido)
400	Solicitação BadRequest	EmptyValue - \r\nParameter name: token (token não enviado)
400	Solicitação BadRequest	SURVEY_HAS_ALREADY_BEEN_ANSWERED (foi enviado `false` como um órgão e a pesquisa já foi respondida)