Async

Request body description:

{
    "query": "string",
    "parameters": {"string":"string"},
     "webhook": {
        "url": "",
        "fallbackUrl": "",
        "authorization": {
          "headers": [
            {
              "name": "nomeCabecalho1",
              "value": "valorCabecalho1"
            },
            {
              "name": "nomeCabecalho2",
              "value": "valorCabecalho2"
            }
          ],
          "queryStrings": [
            {
              "name": "nomeQs1",
              "value": "valorQs1"
            },
            {
              "name": "nomeQs2",
              "value": "valorQs2"
            }
          ]
        }
      }
}

Parameters table

Table

Name	Type	Required	Note
query	String	Yes	Query identifier name, for example, pf, pf full, pj, or pj full (standard queries) or a customized name defined by support according to the client necessities and applications (customized queries)
parameters	String	Yes	Required parameter(s) for the datasets that compose the query. Click here to check the list of available datasets and their respective required parameters (column G).
webhook.url	String	No	Endpoint to which mostQI Enrichment will make a request, sending the query result.
webhook.fallbackUrl	String	No	Parameter that allows specifying an alternative URL in case of communication failure during the call to the URL indicated in the 'webhook.url' parameter.
webhook.authorization.headers	String	No	Parameter that allows specifying which headers mostQI Enrichment will pass on to the server specified in the 'webhook.url' or 'webhook.fallbackUrl' parameter
webhook.authorization.queryStrings	String	No	Parameter that allows specifying which query strings mostQI Enrichment will pass on to the server specified in the 'webhook.url' or 'webhook.fallbackUrl' parameter.

*Details of dataset error messages are in Table 4 of the Annex.

Request

Header Params

Authorization

string

required

Authorization Token obtained from the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

query

string

required

parameters

object

required

string

required

webhook

object

required

url

string

required

fallbackUrl

string

required

authorization

object

required

Example

{
  "query": "string",
  "parameters": {
    "string": "string"
  },
  "webhook": {
    "url": "",
    "fallbackUrl": "",
    "authorization": {
      "headers": [
        {
          "name": "nomeCabecalho1",
          "value": "valorCabecalho1"
        },
        {
          "name": "nomeCabecalho2",
          "value": "valorCabecalho2"
        }
      ],
      "queryStrings": [
        {
          "name": "nomeQs1",
          "value": "valorQs1"
        },
        {
          "name": "nomeQs2",
          "value": "valorQs2"
        }
      ]
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 OK Response

application/json

Body

result

object

required

processId

string

required

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

message

string

required

code

string

required

errors

array[string]

required

Example

{
  "result": {
    "processId": "45d6O70c-54a7-5fab-xxxe-a3b7a0c2a06d"
  },
  "requestId": "tZfL59xpzkWXE3uk95t9U",
  "elapsedMilliseconds": 38,
  "status": {
    "message": "OK",
    "code": "200",
    "errors": []
  }
}

🟠400400 Bad Request Response

Request body description:#

Parameters table#

Table#

Request

Request samples

Responses

Request body description:

Parameters table

Table