Consultation API
search

Next

Answers a question or uses the "help me solve" / "fast forward".

POST/rest/consultation/next
 Query parameters
  • fastForward: optional boolean (default=false). With fastForward=true the parameters in the body can be empty.
  • helpMeSolve: optional string (default="").
 Header
  • auth-token: value of the authentication token
  • Content-Type: application/json
  • consultationId: value of the consultationId
 Header/Parameter  tenant
 Body NextRequest
Returns ConsultationResponse
Required role USER
Managed errors
  • 400: bad request (validation issues)
  • 404: kb not found
  • 401: insufficient privileges

Example request

curl 'http://locahost:8080/mwp/rest/consultation/next' -H 'consultationId: d6bf487a953f0a323624c4a89f98fe77' -H 'Content-Type: application/json' -H 'tenant:default' -H 'auth-token: 5f4a627d-d749-49ee-9cd7-616968462ffc' --data-binary '{"parameters":[{"id":{"name":"Credit limit","instanceBaseName":null,"instanceNumber":1},"values":["Exceeded"]}],"requestedParameters":[{"name":"Deler vermenigvuldigingsfactor franchise","instanceNumber":1,"instanceBaseName":null,"value":"[]"},{"name":"AOW uitkering","instanceNumber":1,"instanceBaseName":null,"value":"[]"}]}'

Example response

{  
   "consultationId":"d6bf487a953f0a323624c4a89f98fe77",
   "variables":[  
      {  
         "id":"Order_Handling-Important_customer-1",
         "name":"Important customer",
         "instanceIndex":1,
         "instanceBaseName":null,
         "type":"qualitativeEnumeration",
         "question":"Is this client important for our company?",
         "explanation":"",
         "domain":{  
            "alternatives":[  
               {  
                  "value":"Yes",
                  "explanation":null,
                  "multimediaExplanation":null
               },
               {  
                  "value":"No",
                  "explanation":null,
                  "multimediaExplanation":null
               }
            ],
            "constraints":{  
               "numbersConstraints":null,
               "stringsConstraints":{  
                  "maxLength":0,
                  "minLength":0
               },
               "defaultValue":""
            },
            "exclusiveValue":null,
            "defaultValue":""
         },
         "display":false,
         "frameName":null,
         "maskedValue":null,
         "solvable":true,
         "metricSystem":"EU",
         "storedValues":null,
         "decimalSeparator":null,
         "thousandsSeparator":null
      }
   ],
   "requestedVariables":[
	{
          "name":"Deler vermenigvuldigingsfactor franchise",
	  "instanceNumber":1,
	  "instanceBaseName":null,
	  "value":"[66,28]"
	},
	{
	  "name":"AOW uitkering",
	  "instanceNumber":1,
	  "instanceBaseName":null,
	  "value":"[14211,00]"
	}
   ],
   "questionType":"question",
   "tableName":"Order Handling",
   "displayVariables":[  

   ],
   "downloads":null,
   "answeredQuestions":null,
   "visualizationConfiguration":[  

   ],
   "summaryChecklist":{  
      "type":"NONE",
      "content":null
   },
   "responseExtensions":null,
   "feedback":null,
   "userType":null
}

Feedback