Form Contacts

get form contacts

GEThttps://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts

Query parameters

Response

200401

OK

Body

application/json

count*integer (int32)

results*array of getformcontacts_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurl

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

Response

{
  "count": 2,
  "results": [
    {
      "form_id": {},
      "count": 0,
      "invalidated_contacts": []
    },
    {
      "form_id": {},
      "count": 0,
      "invalidated_contacts": []
    }
  ],
  "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
}

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

GEThttps://ushahididocs.api.ushahidi.io/api/v3/forms/6/contacts/2

Response

200401404

OK

Body

application/json

form_id*getformcontacts_form_id (object)

count*integer (int32)

invalidated_contacts*array of string

Request

JavaScriptCurl

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

Response

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

delete form contact

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/forms/9/contacts/1

Response

200401404

OK

Body

application/json

form_id*getformcontacts_form_id (object)

count*integer (int32)

invalidated_contacts*array of string

Request

JavaScriptCurl

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

Response

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