Notification

get notifications

GEThttps://ushahididocs.api.ushahidi.io/api/v3/notifications

Query parameters

Response

200401

OK

Body

application/json

count*integer (int32)

results*array of getnotifications_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

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

GEThttps://ushahididocs.api.ushahidi.io/api/v3/notifications/6

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

user*createsavedsearch_user (object)

Example: "{\"id\":1,\"url\":\"http://localhost:8000/api/v3/users/1\"}"

set*getcollectionposts_form (object)

created*string

updated*nullable string

allowed_privileges*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/notifications/6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/notifications/6

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

user*createsavedsearch_user (object)

Example: "{\"id\":1,\"url\":\"http://localhost:8000/api/v3/users/1\"}"

set*getcollectionposts_form (object)

created*string

updated*nullable string

allowed_privileges*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/notifications/6', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200401404

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