Form Contacts
Authorizations
Query parameters
orderbystringOptionalExample:
Sorting parameter Available values : entity fields Default value : id
id
orderstringOptionalExample:
Sorting parameter Available values : [ASC,DESC] !! Default value : ASC "default not working"
Desc
limitinteger · int32OptionalExample:
Paging parameter Default value : null
2
offsetinteger · int32OptionalExample:
Paging parameter Default value : 0
3
contactsstringOptionalExample:
Filter parameter check the contact value
test
Responses
200
OK
application/json
401
Unauthorized
application/json
get
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
{
"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
{
"form_id": 9,
"count": 1,
"invalidated_contacts": []
}{
"form_id": 9,
"count": 1,
"invalidated_contacts": []
}
Authorizations
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
get
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": []
}
Authorizations
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
delete
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": []
}