CheckTicketsQuestions

This method allows queries to determine which requirements tickets may have.

Thanks to this, when we call this method, the response will return the information as questions together with the indications that were previously defined for their use.

Access method

POST /activity/checkticketsquestions

Request structure

To generate the request structure, an object must be sent with the following fields.

• ProductIds: (list). Array of product identifiers.
• TicketsQuestionsProfileIds: (list). Array of question profile identifiers associated with the ticket.
• LanguageCode: (list). Language code.

Request examples

ProductIdsTicketsQuestionsProfileIdsLanguageCode

{
    "ProductIds": 
    [
        "MyProductId01",
        "MyProductId02",
        "MyProductId03"
    ]
}

{
    "TicketsQuestionsProfileIds": 
    [
        "MyTicketsQuestionsProfileIds01",
        "MyTicketsQuestionsProfileIds02",
        "MyTicketsQuestionsProfileIds03"
    ]
}

{
    "LanguageCode": 
    [
        null
    ]
}

Response structure

The response structure is very similar to the request, but includes some additional fields.

• Products: (list). List of products.

  • ProductId: (string). Product identifier.
  • Tickets: (list). List of tickets.
    • TicketId: (string). Ticket identifier.
    • TicketQuestionsProfileId: (string). Question profile identifier.

• TicketQuestionsProfiles: (list). List of question profiles.

  • Id: (string). Identifier.

  • Questions: (list). List of the corresponding questions.

    • Id: (string). Question identifier.
    • Question: (string). Main question.
    • ShortQuestion: (string). Short question.
    • Required: (boolean). Indicates whether the question is mandatory.

    • DataType: (numeric). Question data type. It can take the following values.

      Possible values

      • 0: Text
      • 2: Boolean
      • 4: Date
      • 6: Integer number
      • 8: Decimal number
      • 10: Select one value from a predefined set of values.
      • 11: Select multiple values from a predefined set of values.
      • 12: File.

    • Values: (string). Array with the corresponding values.

• Success (boolean): value that indicates whether the call was processed correctly or not.

• Timestamp (dateTime): time at which the request was processed. ISO 8601 format (yyyy-MM-ddThh:mm:ss.fffffff).
• ErrorMessage (string): error message explaining why the request was not successful. If it was correct, it will return null.
• ErrorCodes (string[]): list of codes that identify the errors that occurred in the call.
• ErrorEntityBreakDown (list): list that contains objects with the name and ID in case of error.
  • Id (string): identifier
  • Name (string): related name of the identifier.

Response examples

Text questionBoolean questionDate questionInteger questionDecimal questionSingle predefined value questionMultiple predefined values questionFile question

{
    {
    "TicketQuestionsProfiles": [
        {
            "Id": "pdk563qjqkyns",
            "AreDynamicQuestions": false,
            "Questions": [
                {
                    "Id": "xsdt8tj1g9zrh",
                    "Required": false,
                    "DataType": 0,
                    "RegexValidationPattern": "patron validación",
                    "RegexValidationErrorMessage": "mensaje error"
                }
            ]
        }
    ],
    "Success": true,
    "Timestamp": "2023-03-13T00:00:00"
    }
}

{
    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "89tbrdp6gi6oh",
                        "Question": "pregunta booleano",
                        "ShortQuestion": "corta booleao",
                        "Required": false,
                        "DataType": 2
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }
}

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "zfufit3d3kofa",
                        "Question": "Pregunta Fecha",
                        "ShortQuestion": "pregunta abreviada ",
                        "Required": false,
                        "DataType": 4
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "dz5877yi6wjfk",
                        "Question": "preguntna numero entero",
                        "ShortQuestion": "abreviada entero",
                        "Required": false,
                        "DataType": 6
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "86h1dnjfzy6ma",
                        "Question": "¿Pregunta principal para decimal?",
                        "ShortQuestion": "pregunta corta",
                        "Required": false,
                        "DataType": 8
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "4gc7t9kb6aark",
                        "Question": "¿Pregunta principal para seleccionar uno?",
                        "ShortQuestion": "pregunta corta",
                        "Required": false,
                        "DataType": 10,
                        "Values": []
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "p68wgknpsgx4c",
                        "Question": "¿Pregunta principal para seleccionar varios?",
                        "ShortQuestion": "¿Pregunta corta?",
                        "Required": false,
                        "DataType": 11,
                        "MaxNumberOfValues": 2,
                        "Values": []
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }

    {
        "TicketQuestionsProfiles": [
            {
                "Id": "pdk563qjqkyns",
                "AreDynamicQuestions": false,
                "Questions": [
                    {
                        "Id": "8bkbihetazhcs",
                        "Question": "¿Pregunta principal para archivos?",
                        "ShortQuestion": "¿Pregunta corta?",
                        "Required": false,
                        "DataType": 12
                    }
                ]
            }
        ],
        "Success": true,
        "Timestamp": "2023-03-13T00:00:00"
    }