v3 Ushahidi Platform REST API Documentation

Tos

Add tos

POST https://ushahididocs.api.ushahidi.io/api/v3/tos

Request Body

Name

Type

Description

user_id

String

The user identifier

tos_version_date

String

The version date of "tos"

{
  "counts": 0,
  "results": [
    {
      "id": 0,
      "url": "string",
      "user": {
        "id": 0,
        "url": "string"
      },
      "agreement_date": "string",
      "tos_version_date": "string",
      "allowed_privileges": [
        "string"
      ]
    }
  ]
}

PreviousCountry Code NextPermissons

Get all tos

get

/api/v3/tos

Authorizations

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : id

orderstring

Sorting parameter Available values : [ASC,DESC] Default value : DESC

limitinteger · int32

Paging parameter Default value : 1

offsetinteger · int32

Paging parameter Default value : 0

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

{
  "count": 10,
  "limit": "10",
  "offset": "5",
  "order": "ASC",
  "orderby": "tos_version_date",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/tos?orderby=tos_version_date&order=ASC&limit=10&offset=5",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/tos?orderby=tos_version_date&order=ASC&limit=10&offset=15",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/tos?orderby=tos_version_date&order=ASC&limit=10&offset=0",
  "total_count": 40,
  "results": [
    {
      "id": 12,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/12",
      "agreement_date": "2022-09-30T18:49:29.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 13,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/13",
      "agreement_date": "2022-09-30T19:10:13.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 14,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/14",
      "agreement_date": "2022-09-30T22:16:06.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 15,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/15",
      "agreement_date": "2022-09-30T22:18:18.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 11,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/11",
      "agreement_date": "2022-09-30T18:46:24.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 10,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/10",
      "agreement_date": "2022-09-27T23:39:04.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 9,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/9",
      "agreement_date": "2022-09-27T23:38:16.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 7,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/7",
      "agreement_date": "2022-09-27T23:09:50.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 6,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/6",
      "agreement_date": "2022-09-27T22:22:49.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    },
    {
      "id": 5,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/5",
      "agreement_date": "2022-09-27T22:22:33.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ],
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      }
    }
  ]
}

Get tos

get

/api/v3/tos/100