YesNo

POST /v1/form/update

Below is an example illustrating the consumable format of YESNO. The 'NEXT' status indicates that you haven't reached the end of the form yet. Each question is uniquely identified by an ID stored in 'questionId', with the source being a list of options available for selection.

Object

{
    "status": "NEXT",
    "refId": "SLH-4UN0RDF0990D",
    "question": {
        "questionId": "c3ce1796-5164-4f1a-a86b-11698dfaaeee",
        "question": "Do you have a car?",
        "kind": "YesNoComponent",
        "settings": {
            "source": [
                "Yes",
                "No"
            ]
        }
    },
    "review": [],
    "message": null,
    "invoice": {
        "title": "Question Engine All cards No logic",
        "quantity": 1,
        "currency": "XOF",
        "totalCost": 1000.0
    }
}

Response to the question

YESNO format anticipates a single selection from the provided source.

Headers

Name	Value
Content-Type	application/json
CLIENT_ID	<client id>

Body

In addition to the API keys specified in the Headers, ensure to include the eServiceId, refId, ,questionId. Upon a successful request, you will receive the next question. You'll recognize reaching the end of the form when the status is 'COMPLETED'.

values class field(s)	Format
value	option from provided source (case sensitive)

Example Request

Request Body

{
    "eServiceId": "663835dfae67d8704b6752b7",
    "refId": "SLH-4UN0RDF0990D",
    "questionId": "c3ce1796-5164-4f1a-a86b-11698dfaaeee",
    "values": {
        "value":"Yes"
    }
}

200

400