Form Contacts

get form contacts

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

orderbystringOptional

Sorting parameter Available values : entity fields Default value : id

Example: id

orderstringOptional

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

Example: Desc

limitinteger · int32Optional

Paging parameter Default value : null

Example: 2

offsetinteger · int32Optional

Paging parameter Default value : 0

Example: 3

contactsstringOptional

Filter parameter check the contact value

Example: test

Responses

200

OK

application/json

countinteger · int32Required

limitstring · nullableRequired

offsetinteger · int32Required

orderstringRequired

orderbystringRequired

currstringRequired

nextstringRequired

prevstringRequired

total_countinteger · int32Required

401

Unauthorized

application/json

get

/api/v3/forms/9/contacts

HTTPcURLJavaScriptPython

GET /api/v3/forms/9/contacts HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int32Required

invalidated_contactsstring[]Required

401

Unauthorized

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

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

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

delete form contact

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int32Required

invalidated_contactsstring[]Required

401

Unauthorized

application/json

404

Not Found

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /api/v3/forms/9/contacts/1 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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