Media

get media

GEThttps://ushahididocs.api.ushahidi.io/api/v3/media/1

Response

200404

OK

Body

application/json

id*integer (int32)

url*string

user*createsavedsearch_user (object)

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

caption*string

created*string

updated*string

mime*string

original_file_url*string

original_file_size*integer (int32)

original_width*integer (int32)

original_height*integer (int32)

allowed_privileges*array of string

Request

JavaScriptCurl

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

Response

{
  "id": 1,
  "url": "http://localhost:8000/api/v3/media/1",
  "user": {
    "id": 1,
    "url": "http://localhost:8000/api/v3/users/1"
  },
  "caption": "ihub",
  "created": "2013-10-15T05:43:41+00:00",
  "updated": "2013-10-15T05:43:39+00:00",
  "mime": "image/jpeg",
  "original_file_url": "http://localhost:8000/storage/9ze_1381815819_o.jpg",
  "original_file_size": 1024,
  "original_width": 400,
  "original_height": 500,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

edit media

PUT https://ushahididocs.api.ushahidi.io/api/v3/media/1

Request Body

Name	Type	Description
user_id	String	The user identifier
o_size	String	File Size
o_filename	String	File name
mime	String	Media import location e.g. "image/jpeg"
caption	String	The media caption
original_width	String	Width dimension
original_file_size	String	The media file size
original_file_url	String	The media file URL
original_height	String	Height dimension

200: OK

{
    "id": 1,
    "url": "http://localhost:8000/api/v3/media/1",
    "user": {
        "id": 1,
        "url": "http://localhost:8000/api/v3/users/1"
    },
    "caption": "ihub",
    "created": "2013-10-15T05:43:41+00:00",
    "updated": "2013-10-15T05:43:39+00:00",
    "mime": "image/jpeg",
    "original_file_url": "http://localhost:8000/storage/9ze_1381815819_o.jpg",
    "original_file_size": 1024,
    "original_width": 400,
    "original_height": 500,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

delete media

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/media/3

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\"}"

caption*string

created*string

updated*string

mime*string

original_file_url*string

original_file_size*integer (int32)

original_width*integer (int32)

original_height*integer (int32)

allowed_privileges*array of string

Request

JavaScriptCurl

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

Response

{
  "id": 3,
  "url": "http://localhost:8000/api/v3/media/3",
  "user": {
    "id": 2,
    "url": "http://localhost:8000/api/v3/users/2"
  },
  "caption": "ihub",
  "created": "2013-10-15T05:43:41+00:00",
  "updated": "2013-10-15T05:43:39+00:00",
  "mime": "image/jpeg",
  "original_file_url": "http://localhost:8000/storage/9ze_1381815819_o.jpg",
  "original_file_size": 1024,
  "original_width": 600,
  "original_height": 700,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}