Form Contacts

get form contacts

get

/api/v3/forms/9/contacts

Authorizations

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : id

Example: id

orderstring

Sorting parameter Available values : [ASC,DESC] !! Default value : ASC "default not working"

Example: Desc

limitinteger · int32

Paging parameter Default value : null

Example: 2

offsetinteger · int32

Paging parameter Default value : 0

Example: 3

contactsstring

Filter parameter check the contact value

Example: test

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

200

{
  "count": 2,
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "http://localhost:8000/api/v3/forms/9/contacts?orderby=id&order=asc&offset=0",
  "next": "http://localhost:8000/api/v3/forms/9/contacts?orderby=id&order=asc&offset=0",
  "prev": "http://localhost:8000/api/v3/forms/9/contacts?orderby=id&order=asc&offset=0",
  "total_count": 2,
  "results": [
    {
      "count": 0,
      "invalidated_contacts": [],
      "form_id": {}
    },
    {
      "count": 0,
      "invalidated_contacts": [],
      "form_id": {}
    }
  ]
}

OK

get form contacts

POST https://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts

Request Body

Name	Type	Description
contacts	String

200: OK

{
    "form_id": 9,
    "count": 1,
    "invalidated_contacts": []
}{
    "form_id": 9,
    "count": 1,
    "invalidated_contacts": []
}

edit form contact

PUT https://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts/15

Request Body

Name	Type	Description
contacts	String

200: OK

{
    "form_id": 9,
    "count": 1,
    "invalidated_contacts": []
}{
    "form_id": 9,
    "count": 1,
    "invalidated_contacts": []
}

get form contact

get

/api/v3/forms/6/contacts/2

Authorizations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/forms/6/contacts/2' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

200

{
  "count": 0,
  "invalidated_contacts": [],
  "form_id": {}
}

OK

delete form contact

delete

/api/v3/forms/9/contacts/1

Authorizations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts/1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

200

{
  "count": 0,
  "invalidated_contacts": [],
  "form_id": {}
}

OK