Surveys

Get surveys

get

/surveys

Authorizations

Query parameters

onlystring

Data parameter determine which fields of the survey will be returned

Example: id,name

hydratestring

Data parameter determine which relations of the survey will be returned

Example: translation

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v5/surveys' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Add a survey

post

/surveys

Authorizations

Body

all of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ushahididocs.api.ushahidi.io/api/v5/surveys' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test2",
    "description": "test desc 2",
    "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": "A sentence or less",
            "$$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": []
    }
  }'

201

422

201

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

Created

Get survey

get

/surveys/100

Authorizations

Query parameters

hydratestring

Data parameter determine which relations of the survey will be returned

Example: translations

onlystring

Data parameter determine which fields of the survey will be returned

Example: id,name

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v5/surveys/100' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

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

OK

Edit survey

put

/surveys/2

Authorizations

Body

all of

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://ushahididocs.api.ushahidi.io/api/v5/surveys/2' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test2",
    "description": "test desc 2",
    "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": "A sentence or less",
            "$$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": []
    }
  }'

200

404

422

200

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

OK

Delete survey

delete

/surveys/8

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v5/surveys/8' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

403

200

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

OK