Notification

get notifications

get

Authorizations

Query parameters

orderbystringOptional

Sorting parameter Available values : entity fields Default value : id

Example: id

orderstringOptional

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

Example: asc

limitinteger · int32Optional

Paging parameter Default value : null

Example: 2

offsetinteger · int32Optional

Paging parameter Default value : 0

Example: 3

userinteger · int32Optional

Filter Parameter check the user id

Example: 2

setinteger · int32Optional

Filter Parameter check the set id

Example: 1

Responses

application/json

objectOptionalExample: {"count":5,"results":[{"id":2,"url":"http://localhost:8000/api/v3/notifications/2","user":{"id":1,"url":"http://localhost:8000/api/v3/users/1"},"set":{"id":2,"url":"http://localhost:8000/api/v3/sets/2"},"created":"1970-01-01T00:00:00+00:00","allowed_privileges":["read","create","update","delete","search"]},{"id":3,"url":"http://localhost:8000/api/v3/notifications/3","user":{"id":1,"url":"http://localhost:8000/api/v3/users/1"},"set":{"id":3,"url":"http://localhost:8000/api/v3/sets/3"},"created":"1970-01-01T00:00:00+00:00","allowed_privileges":["read","create","update","delete","search"]},{"id":4,"url":"http://localhost:8000/api/v3/notifications/4","user":{"id":1,"url":"http://localhost:8000/api/v3/users/1"},"set":{"id":4,"url":"http://localhost:8000/api/v3/sets/4"},"created":"1970-01-01T00:00:00+00:00","allowed_privileges":["read","create","update","delete","search"]},{"id":5,"url":"http://localhost:8000/api/v3/notifications/5","user":{"id":1,"url":"http://localhost:8000/api/v3/users/1"},"set":{"id":4,"url":"http://localhost:8000/api/v3/sets/4"},"created":"1970-01-01T00:00:00+00:00","allowed_privileges":["read","create","update","delete","search"]},{"id":8,"url":"http://localhost:8000/api/v3/notifications/8","user":{"id":2,"url":"http://localhost:8000/api/v3/users/2"},"set":{"id":4,"url":"http://localhost:8000/api/v3/sets/4"},"created":"2022-11-02T19:09:33+00:00","allowed_privileges":["read","create","update","delete","search"]}],"offset":0,"order":"asc","orderby":"id","curr":"http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0","next":"http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0","prev":"http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0","total_count":5}

application/json

get

HTTPcURLJavaScriptPython

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

{
  "count": 5,
  "results": [
    {
      "id": 2,
      "url": "http://localhost:8000/api/v3/notifications/2",
      "user": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/users/1"
      },
      "set": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/sets/2"
      },
      "created": "1970-01-01T00:00:00+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    },
    {
      "id": 3,
      "url": "http://localhost:8000/api/v3/notifications/3",
      "user": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/users/1"
      },
      "set": {
        "id": 3,
        "url": "http://localhost:8000/api/v3/sets/3"
      },
      "created": "1970-01-01T00:00:00+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    },
    {
      "id": 4,
      "url": "http://localhost:8000/api/v3/notifications/4",
      "user": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/users/1"
      },
      "set": {
        "id": 4,
        "url": "http://localhost:8000/api/v3/sets/4"
      },
      "created": "1970-01-01T00:00:00+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    },
    {
      "id": 5,
      "url": "http://localhost:8000/api/v3/notifications/5",
      "user": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/users/1"
      },
      "set": {
        "id": 4,
        "url": "http://localhost:8000/api/v3/sets/4"
      },
      "created": "1970-01-01T00:00:00+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    },
    {
      "id": 8,
      "url": "http://localhost:8000/api/v3/notifications/8",
      "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
      },
      "set": {
        "id": 4,
        "url": "http://localhost:8000/api/v3/sets/4"
      },
      "created": "2022-11-02T19:09:33+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0",
  "next": "http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0",
  "prev": "http://localhost:8000/api/v3/notifications?orderby=id&order=asc&offset=0",
  "total_count": 5
}

add notification

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

Request Body

Name	Type	Description
user_id	Integer	The user identifier
set_id	Integer	Set ID

200: OK

{
    "id": 7,
    "url": "http://localhost:8000/api/v3/notifications/7",
    "user": {
        "id": 4,
        "url": "http://localhost:8000/api/v3/users/4"
    },
    "set": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/sets/1"
    },
    "created": "2022-11-02T19:06:07+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

add notification

PUT https://ushahididocs.api.ushahidi.io/api/v3/notifications/6

Request Body

Name	Type	Description
user_id	Integer	The user identifier
set_id	Integer	Set ID

200: OK

{
    "id": 7,
    "url": "http://localhost:8000/api/v3/notifications/7",
    "user": {
        "id": 4,
        "url": "http://localhost:8000/api/v3/users/4"
    },
    "set": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/sets/1"
    },
    "created": "2022-11-02T19:06:07+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

get notification

get

Authorizations

Responses

application/json

objectOptionalExample: {"id":6,"url":"http://localhost:8000/api/v3/notifications/6","user":{"id":4,"url":"http://localhost:8000/api/v3/users/4"},"set":{"id":4,"url":"http://localhost:8000/api/v3/sets/4"},"created":"1970-01-01T00:00:00+00:00","allowed_privileges":["read","create","update","delete","search"]}

application/json

application/json

get

HTTPcURLJavaScriptPython

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

{
  "id": 6,
  "url": "http://localhost:8000/api/v3/notifications/6",
  "user": {
    "id": 4,
    "url": "http://localhost:8000/api/v3/users/4"
  },
  "set": {
    "id": 4,
    "url": "http://localhost:8000/api/v3/sets/4"
  },
  "created": "1970-01-01T00:00:00+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

delete notification

delete

Authorizations

Responses

application/json

objectOptionalExample: {"id":7,"url":"http://localhost:8000/api/v3/notifications/7","user":{"id":4,"url":"http://localhost:8000/api/v3/users/4"},"set":{"id":1,"url":"http://localhost:8000/api/v3/sets/1"},"created":"2022-11-02T19:06:07+00:00","allowed_privileges":["read","create","update","delete","search"]}

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v3/notifications/6 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 7,
  "url": "http://localhost:8000/api/v3/notifications/7",
  "user": {
    "id": 4,
    "url": "http://localhost:8000/api/v3/users/4"
  },
  "set": {
    "id": 1,
    "url": "http://localhost:8000/api/v3/sets/1"
  },
  "created": "2022-11-02T19:06:07+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}