Tos

Get all tos

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

orderbystringOptional

Sorting parameter Available values : entity fields Default value : id

orderstringOptional

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

limitinteger · int32Optional

Paging parameter Default value : 1

offsetinteger · int32Optional

Paging parameter Default value : 0

Responses

200

OK

application/json

401

Unauthorized

application/json

get

/api/v3/tos

HTTPcURLJavaScriptPython

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

{
  "count": 10,
  "results": [
    {
      "id": 12,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/12",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-30T18:49:29.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 13,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/13",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-30T19:10:13.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 14,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/14",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-30T22:16:06.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 15,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/15",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-30T22:18:18.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 11,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/11",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-30T18:46:24.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 10,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/10",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-27T23:39:04.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 9,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/9",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-27T23:38:16.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 7,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/7",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-27T23:09:50.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 6,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/6",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-27T22:22:49.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    },
    {
      "id": 5,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/5",
      "user": {
        "id": 2,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
      },
      "agreement_date": "2022-09-27T22:22:33.000Z",
      "tos_version_date": "2022-12-27T23:59:30.000Z",
      "allowed_privileges": [
        "read",
        "create",
        "search"
      ]
    }
  ],
  "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
}

Get tos

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

404

Not Found

application/json

get

/api/v3/tos/100

HTTPcURLJavaScriptPython

GET /api/v3/tos/100 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/tos/1",
  "user": {
    "id": 2,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2"
  },
  "agreement_date": "2022-09-27T21:48:06.000Z",
  "tos_version_date": "3647-10-12T21:47:48.000Z",
  "allowed_privileges": [
    "read",
    "create",
    "search"
  ]
}

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"

200: OK

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