DateRange
POST /v1/form/update
Below is an example illustrating the consumable format of DateRangeComponent. 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'.
{
"status": "NEXT",
"refId": "SLH-4UN0RDF0990D",
"question": {
"questionId": "1264876b-3415-4d90-ac77-dbb2ca39553a",
"question": "How long is your vacation?",
"kind": "DateRangeComponent",
"settings": {}
},
"review": [
{
"id": "c3ce1796-5164-4f1a-a86b-11698dfaaeee",
"question": "Do you have a car?",
"answer": "Yes"
}
],
"message": null,
"invoice": {
"title": "Question Engine All cards No logic",
"quantity": 1,
"currency": "XOF",
"totalCost": 1000.0
}
}Response to the question
DateRange format anticipates a date value in the ISO 8601 yyyy-mm-dd format stored in the from and tofield.
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, from and to. Upon a successful request, you will receive the next question. You'll recognize reaching the end of the form when the status is 'COMPLETED'.
Field
Format
from
yyyy-mm-dd (ISO 8601)
to
yyyy-mm-dd (ISO 8601)
Example
{
"eServiceId": "663835dfae67d8704b6752b7",
"refId": "SLH-4UN0RDF0990D",
"questionId": "1264876b-3415-4d90-ac77-dbb2ca39553a",
"values": {
"from":"2024-08-08",
"to":"2024-09-08"
}
}{
"status": "NEXT",
"refId": "SLH-4UN0RDF0990D",
"question": {
"questionId": "f4cf4659-7b5b-46bc-94b2-8f60f144b0dc",
"question": "What is your date of birth?",
"kind": "DateComponent",
"settings": {}
},
"review": [
{
"id": "c3ce1796-5164-4f1a-a86b-11698dfaaeee",
"question": "Do you have a car?",
"answer": "Yes"
},
{
"id": "1264876b-3415-4d90-ac77-dbb2ca39553a",
"question": "How long is your vacation?",
"answer": "08/08/2024 => 08/09/2024"
}
],
"message": null,
"invoice": {
"title": "Question Engine All cards No logic",
"quantity": 1,
"currency": "XOF",
"totalCost": 1000.0
}
}{
"error": {
"code": "invalid_request_error",
"message": "from field is missing"
}
}Last updated