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

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

idinteger · int32Required

urlstringRequired

form_idinteger · int32Required

labelstringRequired

priorityinteger · int32Required

iconstring · nullableRequired

typestringRequired

requiredbooleanRequired

show_when_publishedbooleanRequired

descriptionstring · nullableRequired

task_is_internal_onlybooleanRequired

allowed_privilegesstring[]Required

404

Not Found

application/json

get

/api/v3/forms/4/stages/6

HTTPcURLJavaScriptPython

GET /api/v3/forms/4/stages/6 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

idinteger · int32Required

urlstringRequired

form_idinteger · int32Required

labelstringRequired

priorityinteger · int32Required

iconstring · nullableRequired

typestringRequired

requiredbooleanRequired

show_when_publishedbooleanRequired

descriptionstring · nullableRequired

task_is_internal_onlybooleanRequired

allowed_privilegesstring[]Required

401

Unauthorized

application/json

404

Not Found

application/json

delete

/api/v3/forms/2/stages/4

HTTPcURLJavaScriptPython

DELETE /api/v3/forms/2/stages/4 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
  ]
}