Surveys

Get surveys

GEThttps://ushahididocs.api.ushahidi.io/api/v5/surveys

Authorization

bearerAuth

Query parameters

Response

200

OK

Body

application/json

results*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/surveys', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": 1,
      "name": "text",
      "translations": {
        "name": "text",
        "description": "text",
        "allOf": {
          "es": {
            "name": "text",
            "description": "text"
          }
        }
      }
    }
  ]
}

Add a survey

POSThttps://ushahididocs.api.ushahidi.io/api/v5/surveys

Authorization

bearerAuth

Body

application/json

namestring

descriptionstring

base_languagestring

colornullable string

require_approvalboolean

everyone_can_createboolean

translationsobject

tasksarray of object

enabled_languagesobject

any

Example: {"name":"test2","description":"<p>test desc 2</p>","base_language":"en-US","require_approval":true,"everyone_can_create":true,"translations":{},"tasks":[{"priority":0,"required":false,"type":"post","label":"Post","show_when_published":true,"task_is_internal_only":false,"translations":{},"fields":[{"cardinality":0,"input":"text","priority":1,"required":true,"label":"Title","type":"title","config":{},"form_stage_id":"interim_id_0","translations":{},"$$hashKey":"object:830"},{"cardinality":0,"input":"text","priority":2,"required":true,"label":"Description","type":"description","options":[],"config":{},"form_stage_id":"interim_id_1","translations":{},"$$hashKey":"object:831"}],"is_public":true},{"required":false,"fields":[{"required":false,"options":[],"config":{},"priority":0,"translations":{},"label":"field 2","type":"varchar","input":"text","description":"<p>A sentence or less</p>","$$hashKey":"object:893","instructions":"","form_stage_id":"interim_id_3"}],"type":"task","show_when_published":false,"task_is_internal_only":true,"label":"task 2","priority":1,"$$hashKey":"object:867"}],"enabled_languages":{"default":"en-US","available":[]}}

Response

201422

Created

Body

application/json

results*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/surveys', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "test2",
      "description": "<p>test desc 2</p>",
      "base_language": "en-US",
      "require_approval": true,
      "everyone_can_create": true,
      "translations": {},
      "tasks": [
        {
          "priority": 0,
          "required": false,
          "type": "post",
          "label": "Post",
          "show_when_published": true,
          "task_is_internal_only": false,
          "translations": {},
          "fields": [
            {
              "cardinality": 0,
              "input": "text",
              "priority": 1,
              "required": true,
              "label": "Title",
              "type": "title",
              "config": {},
              "form_stage_id": "interim_id_0",
              "translations": {},
              "$$hashKey": "object:830"
            },
            {
              "cardinality": 0,
              "input": "text",
              "priority": 2,
              "required": true,
              "label": "Description",
              "type": "description",
              "options": [],
              "config": {},
              "form_stage_id": "interim_id_1",
              "translations": {},
              "$$hashKey": "object:831"
            }
          ],
          "is_public": true
        },
        {
          "required": false,
          "fields": [
            {
              "required": false,
              "options": [],
              "config": {},
              "priority": 0,
              "translations": {},
              "label": "field 2",
              "type": "varchar",
              "input": "text",
              "description": "<p>A sentence or less</p>",
              "$$hashKey": "object:893",
              "instructions": "",
              "form_stage_id": "interim_id_3"
            }
          ],
          "type": "task",
          "show_when_published": false,
          "task_is_internal_only": true,
          "label": "task 2",
          "priority": 1,
          "$$hashKey": "object:867"
        }
      ],
      "enabled_languages": {
        "default": "en-US",
        "available": []
      }
    }),
});
const data = await response.json();

Response

201422

{
  "results": [
    {
      "id": 1,
      "name": "text",
      "translations": {
        "name": "text",
        "description": "text",
        "allOf": {
          "es": {
            "name": "text",
            "description": "text"
          }
        }
      }
    }
  ]
}

Get survey

GEThttps://ushahididocs.api.ushahidi.io/api/v5/surveys/100

Authorization

bearerAuth

Query parameters

Response

200404

OK

Body

application/json

results*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/surveys/100', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": 1,
      "name": "text",
      "translations": {
        "name": "text",
        "description": "text",
        "allOf": {
          "es": {
            "name": "text",
            "description": "text"
          }
        }
      }
    }
  ]
}

Edit survey

PUThttps://ushahididocs.api.ushahidi.io/api/v5/surveys/2

Authorization

bearerAuth

Body

application/json

statusinteger

messagestring

any

Example: {"name":"test2","description":"<p>test desc 2</p>","base_language":"en-US","require_approval":true,"everyone_can_create":true,"translations":{},"tasks":[{"priority":0,"required":false,"type":"post","label":"Post","show_when_published":true,"task_is_internal_only":false,"translations":{},"fields":[{"cardinality":0,"input":"text","priority":1,"required":true,"label":"Title","type":"title","config":{},"form_stage_id":"interim_id_0","translations":{},"$$hashKey":"object:830"},{"cardinality":0,"input":"text","priority":2,"required":true,"label":"Description","type":"description","options":[],"config":{},"form_stage_id":"interim_id_1","translations":{},"$$hashKey":"object:831"}],"is_public":true},{"required":false,"fields":[{"required":false,"options":[],"config":{},"priority":0,"translations":{},"label":"field 2","type":"varchar","input":"text","description":"<p>A sentence or less</p>","$$hashKey":"object:893","instructions":"","form_stage_id":"interim_id_3"}],"type":"task","show_when_published":false,"task_is_internal_only":true,"label":"task 2","priority":1,"$$hashKey":"object:867"}],"enabled_languages":{"default":"en-US","available":[]}}

Response

200404422

OK

Body

application/json

results*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/surveys/2', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "test2",
      "description": "<p>test desc 2</p>",
      "base_language": "en-US",
      "require_approval": true,
      "everyone_can_create": true,
      "translations": {},
      "tasks": [
        {
          "priority": 0,
          "required": false,
          "type": "post",
          "label": "Post",
          "show_when_published": true,
          "task_is_internal_only": false,
          "translations": {},
          "fields": [
            {
              "cardinality": 0,
              "input": "text",
              "priority": 1,
              "required": true,
              "label": "Title",
              "type": "title",
              "config": {},
              "form_stage_id": "interim_id_0",
              "translations": {},
              "$$hashKey": "object:830"
            },
            {
              "cardinality": 0,
              "input": "text",
              "priority": 2,
              "required": true,
              "label": "Description",
              "type": "description",
              "options": [],
              "config": {},
              "form_stage_id": "interim_id_1",
              "translations": {},
              "$$hashKey": "object:831"
            }
          ],
          "is_public": true
        },
        {
          "required": false,
          "fields": [
            {
              "required": false,
              "options": [],
              "config": {},
              "priority": 0,
              "translations": {},
              "label": "field 2",
              "type": "varchar",
              "input": "text",
              "description": "<p>A sentence or less</p>",
              "$$hashKey": "object:893",
              "instructions": "",
              "form_stage_id": "interim_id_3"
            }
          ],
          "type": "task",
          "show_when_published": false,
          "task_is_internal_only": true,
          "label": "task 2",
          "priority": 1,
          "$$hashKey": "object:867"
        }
      ],
      "enabled_languages": {
        "default": "en-US",
        "available": []
      }
    }),
});
const data = await response.json();

Response

200404422

{
  "results": [
    {
      "id": 1,
      "name": "text",
      "translations": {
        "name": "text",
        "description": "text",
        "allOf": {
          "es": {
            "name": "text",
            "description": "text"
          }
        }
      }
    }
  ]
}

Delete survey

DELETEhttps://ushahididocs.api.ushahidi.io/api/v5/surveys/8

Authorization

bearerAuth

Response

200403

OK

Body

application/json

resultobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/surveys/8', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200403

{
  "result": {
    "deleted": 8
  }
}