Form Stages

add form stage

POST https://ushahididocs.api.ushahidi.io/api/v3/forms/4/stages

Request Body

Name	Type	Description
form_id	Integer	Form identifier
task_is_internal_only	Boolean	Set form task as internal only, True for yes and Flase for no
type	String	Stage type
icon	String	Form stage Icon
priority	Integer	Stage priority
label	String	Stage label
description	String	Form stage description
show_when_published	Boolean	Set to True to show the form when published and False to not
required	Boolean	Set stage as required for True and optional for False

200: OK

{
    "id": 19,
    "url": "http://localhost:8000/api/v3/form_stages/19",
    "form_id": 4,
    "label": "restricted",
    "priority": 1,
    "icon": null,
    "type": "task",
    "required": false,
    "show_when_published": false,
    "description": null,
    "task_is_internal_only": false,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

edit form stage

PUT https://ushahididocs.api.ushahidi.io/api/v3/forms/4/stages/6

Request Body

Name	Type	Description
form_id	Integer	Form identifier
task_is_internal_only	Boolean	Set form task as internal only, True for yes and Flase for no
type	String	Stage type
icon	String	Form stage Icon
priority	Integer	Stage priority
label	String	Stage label
description	String	Form stage description
show_when_published	Boolean	Set to True to show the form when published and False to not
required	Boolean	Set stage as required for True and optional for False

200: OK

{
    "id": 19,
    "url": "http://localhost:8000/api/v3/form_stages/19",
    "form_id": 4,
    "label": "restricted",
    "priority": 1,
    "icon": null,
    "type": "task",
    "required": false,
    "show_when_published": false,
    "description": null,
    "task_is_internal_only": false,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

get form stage

GEThttps://ushahididocs.api.ushahidi.io/api/v3/forms/4/stages/6

Response

200404

OK

Body

application/json

id*integer (int32)

url*string

form_id*integer (int32)

label*string

priority*integer (int32)

icon*nullable string

type*string

required*boolean

show_when_published*boolean

description*nullable string

task_is_internal_only*boolean

allowed_privileges*array of string

Request

JavaScriptCurl

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/forms/4/stages/6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 4,
  "url": "http://localhost:8000/api/v3/form_stages/4",
  "form_id": 2,
  "label": "Main",
  "priority": 1,
  "type": "post",
  "required": false,
  "show_when_published": true,
  "task_is_internal_only": false,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

delete form stage

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/forms/2/stages/4

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

form_id*integer (int32)

label*string

priority*integer (int32)

icon*nullable string

type*string

required*boolean

show_when_published*boolean

description*nullable string

task_is_internal_only*boolean

allowed_privileges*array of string

Request

JavaScriptCurl

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/forms/2/stages/4', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 4,
  "url": "http://localhost:8000/api/v3/form_stages/4",
  "form_id": 2,
  "label": "Main",
  "priority": 1,
  "type": "post",
  "required": false,
  "show_when_published": true,
  "task_is_internal_only": false,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}