Posts

Get a List of post

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

Query parameters

Response

200

OK

Body

application/json

countsinteger

resultsarray of PostResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

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

Response

200

{
  "counts": 0,
  "results": [
    {
      "id": 0,
      "url": "text",
      "user": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "parent_id": 0,
      "form": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "title": "text",
      "content": "text",
      "message": "text",
      "color": "text",
      "type": "text",
      "slug": "text",
      "author_email": "text",
      "author_realname": 0,
      "status": "text",
      "created": "text",
      "updated": "text",
      "locale": "text",
      "values": [
        "text"
      ],
      "post_date": "text",
      "tags": [
        "text"
      ],
      "published_to": [
        0
      ],
      "completed_stages": [
        0
      ],
      "sets": [
        0
      ],
      "lock": "text",
      "source": "text",
      "data_source_message_id": "text",
      "allowed_privileges": [
        "text"
      ]
    }
  ],
  "limit": 0,
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}

get post by ID

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{id}

Path parameters

id*string

The post identifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Add new post

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

Request Body

Name	Type	Description
form_id	String	Form unique identifier
slug	String	Post slug
type	String	Post type
message	String	Additiong message for post
url	String	Post URL
author_email	String	Email address of source
title	String	Title of the new post
content	String	Post content
user_id	Integer	The user's unique Identifier
author_realname	String	The full name of the Post source
status	String	The status of post
locale	String	Post local language
color	String	Post color
id	String	Unique identifier for new post
parent_id	Integer	Parent ID for new post
values	Object	This is an array containing two items, one for the title and the description
completed_stages	Array	Contains an array of post-completed stage
published_to	Array	This contains an array of where the post was published
source	String	Source of post
sets	Array	An array of set id's
tags	Array	Contains an object of tag Id's
contact	String	Post contact

200: OK

{
  "id": 0,
  "url": "string",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "string",
  "content": "string",
  "message": "string",
  "color": "string",
  "type": "string",
  "slug": "string",
  "author_email": "string",
  "author_realname": 0,
  "status": "string",
  "created": "string",
  "updated": "string",
  "locale": "string",
  "values": [
    "string"
  ],
  "post_date": "string",
  "tags": [
    "string"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "string",
  "source": "string",
  "data_source_message_id": "string",
  "allowed_privileges": [
    "string"
  ]
}

Edit a post by ID

PUT https://ushahididocs.api.ushahidi.io/api/v3/posts/{id}

Path Parameters

Name	Type	Description
id*	integer	The post identifier

Request Body

Name	Type	Description
form_id	Integer	Form unique identifier
slug	String	Post slug
type	String	Post type
message	String	Additiong message for post
url	String	Post URL
author_email	String	Email address of source
title	String	Title of the new post
content	String	Post content
user_id	Integer	The user's unique Identifier
author_realname	String	The full name of the Post source
status	String	The status of post
locale	String	Post local language
color	String	Post color
id	String	Unique identifier of post
values	String	This is an array containing two items, one for the title and the description
published_to	Array	This contains an array of where the post was published
source	String	Source of post
sets	String	An array of set id's
tags	String	Contains an array of tag Id's
contact	String	Post contact

200: OK

{
  "id": 0,
  "url": "string",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "string",
  "content": "string",
  "message": "string",
  "color": "string",
  "type": "string",
  "slug": "string",
  "author_email": "string",
  "author_realname": 0,
  "status": "string",
  "created": "string",
  "updated": "string",
  "locale": "string",
  "values": [
    "string"
  ],
  "post_date": "string",
  "tags": [
    "string"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "string",
  "source": "string",
  "data_source_message_id": "string",
  "allowed_privileges": [
    "string"
  ]
}

Delete post

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/posts/{id}

Path parameters

id*string

The post identifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Get posts status

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/stats

Query parameters

Response

200

OK

Body

application/json

totalsarray of PostsStatusResponse_totals (object)

group_bystring

group_by_attribute_keystring

timeline_attributestring

Request

JavaScriptCurlPython

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

Response

200

{
  "totals": [
    {
      "key": "text",
      "values": [
        {
          "label": "text",
          "total": 0,
          "id": "text",
          "type": "text"
        }
      ]
    }
  ],
  "group_by": "text",
  "group_by_attribute_key": "text",
  "timeline_attribute": "text"
}

Get posts geometry

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/geojson

Query parameters

Response

200

OK

Body

application/json

typestring

featuresarray of PostsGeoResponse_features (object)

totalinteger

Request

JavaScriptCurlPython

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

Response

200

{
  "type": "text",
  "features": [
    {
      "type": "text",
      "geometry": {
        "type": "text",
        "geometries": [
          {
            "type": "text",
            "coordinates": [
              0
            ]
          }
        ]
      },
      "properties": {
        "title": "text",
        "description": "text",
        "marker-color": "text",
        "id": 0,
        "url": "text"
      }
    }
  ],
  "total": 0
}

get posts geojson dimentions

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/geojson/{zoom}/{x}/{y}

Path parameters

zoom*string

Zoom count. i.e how many times location should be zoomed

x*string

Zoom X axis

y*string

Zoom Y axis

Query parameters

Response

200

OK

Body

application/json

typestring

featuresarray of PostsGeoResponse_features (object)

totalinteger

Request

JavaScriptCurlPython

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

Response

200

{
  "type": "text",
  "features": [
    {
      "type": "text",
      "geometry": {
        "type": "text",
        "geometries": [
          {
            "type": "text",
            "coordinates": [
              0
            ]
          }
        ]
      },
      "properties": {
        "title": "text",
        "description": "text",
        "marker-color": "text",
        "id": 0,
        "url": "text"
      }
    }
  ],
  "total": 0
}

Get post geometry

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{post_id}/geojson

Path parameters

post_id*string

Post indentifier

Response

200

OK

Body

application/json

idinteger

urlstring

userPostsLockResponse_user (object)

post_idinteger

expiresinteger

breakablestring

owner_namestring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 0,
  "url": "text",
  "user": {
    "id": 0,
    "url\"": "text"
  },
  "post_id": 0,
  "expires": 0,
  "breakable": "text",
  "owner_name": "text",
  "allowed_privileges": [
    "text"
  ]
}

Edit post lock

PUThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{post_id}/lock

Path parameters

post_id*string

Post indentifier

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

localestring

published_toarray of integer

completed_stagesarray of integer

valuesPosts_values (object)

tagsarray of Posts_tags (object)

Response

200

OK

Body

application/json

idinteger

urlstring

userPostsLockResponse_user (object)

post_idinteger

expiresinteger

breakablestring

owner_namestring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/posts/{post_id}/lock', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "post_id": 96
    }),
});
const data = await response.json();

Response

200

{
  "id": 0,
  "url": "text",
  "user": {
    "id": 0,
    "url\"": "text"
  },
  "post_id": 0,
  "expires": 0,
  "breakable": "text",
  "owner_name": "text",
  "allowed_privileges": [
    "text"
  ]
}

delete post lock

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/posts/{post_id}/lock

Path parameters

post_id*string

Post indentifier

Response

200

OK

Body

application/json

idinteger

urlstring

userPostsLockResponse_user (object)

post_idinteger

expiresinteger

breakablestring

owner_namestring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 0,
  "url": "text",
  "user": {
    "id": 0,
    "url\"": "text"
  },
  "post_id": 0,
  "expires": 0,
  "breakable": "text",
  "owner_name": "text",
  "allowed_privileges": [
    "text"
  ]
}

Sub Posts & Translation

Get post revisions

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions

Path parameters

parent_id*string

Parent Identifier

Query parameters

Response

200404

OK

Body

application/json

countsinteger

resultsarray of PostResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

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

Response

200404

{
  "counts": 0,
  "results": [
    {
      "id": 0,
      "url": "text",
      "user": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "parent_id": 0,
      "form": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "title": "text",
      "content": "text",
      "message": "text",
      "color": "text",
      "type": "text",
      "slug": "text",
      "author_email": "text",
      "author_realname": 0,
      "status": "text",
      "created": "text",
      "updated": "text",
      "locale": "text",
      "values": [
        "text"
      ],
      "post_date": "text",
      "tags": [
        "text"
      ],
      "published_to": [
        0
      ],
      "completed_stages": [
        0
      ],
      "sets": [
        0
      ],
      "lock": "text",
      "source": "text",
      "data_source_message_id": "text",
      "allowed_privileges": [
        "text"
      ]
    }
  ],
  "limit": 0,
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}

Get post revision

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions/105

Path parameters

parent_id*string

Parent Identifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Get post translation

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations

Path parameters

parent_id*string

Parent Identifier

Query parameters

Response

200

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Get post translation

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/{translation_id}

Path parameters

parent_id*string

Parent Identifier

translation_id*string

Translation indentifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Add a post translation

POST https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations

Path Parameters

Name	Type	Description
parent_id**	String	Parent Identifier

Request Body

Name	Type	Description
content	String	Post content
type	String	Post type
author_email	String	Email address of source
message	String	Additional message for post
url	String	Post URL
id	String	Post unique identifier
slug	String	Post slug
user_id	String	Post user indentifier
color	String	Post color
title	String	Post Tiitle
locale	String	The local language of post
status	String	Post status
author_realname	String	The full name of the Post source
published_to	Array	This contains an array of where the post was published
completed_stages	Array	Contains an array of post-completed stage
source	String	The Source of the post contains an array of post-completed stage

200: OK

{
    "id": 10000,
    "url": "http://localhost:8000/api/v3/posts/10000",
    "parent": {
        "id": 97,
        "url": "http://localhost:8000/api/v3/posts/97"
    },
    "form": null,
    "user_id": null,
    "message": null,
    "color": null,
    "type": "report",
    "title": "creat post",
    "slug": "test-create6",
    "content": "test: create new post",
    "author_email": "[e-mail]",
    "author_realname": null,
    "status": "draft",
    "created": "2022-09-02T08:34:57+00:00",
    "updated": null,
    "locale": "fr_fr",
    "values": {
        "markdown": [
            "#markdowny"
        ]
    },
    "post_date": "2022-09-02T08:34:57+00:00",
    "tags": [],
    "published_to": [],
    "completed_stages": [],
    "sets": [],
    "lock": null,
    "source": null,
    "contact": null,
    "data_source_message_id": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "change_status",
        "read_full"
    ]
}

Edit post translation

PUT https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/{translation_id}

Path Parameters

Name	Type	Description
parent_id*	Integer	Parent Identifier
translation_id*	integer	Translation Identifier

Request Body

Name	Type	Description
id	String	Post unique identifier
published_to	Array	Contains an array of post-completed stage
locale	String	The local language of the post
status	String	Post status
author_realname	String	The full name of the Post source
author_email	String	The full name of the Post source
type	String	Post type
color	String	Post color
message	String	Post message
content	String	Content of post
title	String	Post title
user_id	String	Post user identifier
url	String	Post URL
source	String	The Source of the post contains an array of post-completed stage

200: OK

{
    "id": 10000,
    "url": "http://localhost:8000/api/v3/posts/10000",
    "parent": {
        "id": 97,
        "url": "http://localhost:8000/api/v3/posts/97"
    },
    "form": null,
    "user_id": null,
    "message": null,
    "color": null,
    "type": "report",
    "title": "creat post",
    "slug": "test-create6",
    "content": "test: create new post",
    "author_email": "[e-mail]",
    "author_realname": null,
    "status": "draft",
    "created": "2022-09-02T08:34:57+00:00",
    "updated": null,
    "locale": "fr_fr",
    "values": {
        "markdown": [
            "#markdowny"
        ]
    },
    "post_date": "2022-09-02T08:34:57+00:00",
    "tags": [],
    "published_to": [],
    "completed_stages": [],
    "sets": [],
    "lock": null,
    "source": null,
    "contact": null,
    "data_source_message_id": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "change_status",
        "read_full"
    ]
}

Delete post translation

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/{translation_id}

Path parameters

parent_id*string

Parent Identifier

translation_id*string

Translation indentifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Get post local translation

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/(local)

Path parameters

parent_id*string

Parent Identifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}

Edit post local translation

PUT https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/(local)

Path Parameters

Name	Type	Description
parent_id*	Integer	Parent Identifier
local*	String	Post locale

Request Body

Name	Type	Description
id	String	Post unique identifier
published_to	Array	Contains an array of post-completed stage
locale	String	The local language of the post
status	String	Post status
author_realname	String	The full name of the Post source
author_email	String	The full name of the Post source
type	String	Post type
color	String	Post color
message	String	Post message
content	String	Content of post
title	String	Post title
user_id	Integer	Post user identifier
url	String	Post URL
source	String	The Source of the post contains an array of post-completed stage
form_id	Integer	Post form identifier

200: OK

{
    "id": 10000,
    "url": "http://localhost:8000/api/v3/posts/10000",
    "parent": {
        "id": 97,
        "url": "http://localhost:8000/api/v3/posts/97"
    },
    "form": null,
    "user_id": null,
    "message": null,
    "color": null,
    "type": "report",
    "title": "creat post",
    "slug": "test-create6",
    "content": "test: create new post",
    "author_email": "[e-mail]",
    "author_realname": null,
    "status": "draft",
    "created": "2022-09-02T08:34:57+00:00",
    "updated": null,
    "locale": "fr_fr",
    "values": {
        "markdown": [
            "#markdowny"
        ]
    },
    "post_date": "2022-09-02T08:34:57+00:00",
    "tags": [],
    "published_to": [],
    "completed_stages": [],
    "sets": [],
    "lock": null,
    "source": null,
    "contact": null,
    "data_source_message_id": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "change_status",
        "read_full"
    ]}

Delete post local translation

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/(local)

Path parameters

parent_id*string

Parent Identifier

Response

200404

OK

Body

application/json

idinteger

urlstring

user_idinteger

parent_idinteger

form_idinteger

titlestring

contentstring

messagestring

colorstring

typestring

slugstring

author_emailstring

author_realnameinteger

statusstring

createdstring

updatedstring

localestring

valuesarray of string

post_datestring

tagsarray of string

published_toarray of integer

completed_stagesarray of integer

setsarray of integer

lockstring

sourcestring

data_source_message_idstring

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": 0,
  "url": "text",
  "user_id": 0,
  "parent_id": 0,
  "form_id": 0,
  "title": "text",
  "content": "text",
  "message": "text",
  "color": "text",
  "type": "text",
  "slug": "text",
  "author_email": "text",
  "author_realname": 0,
  "status": "text",
  "created": "text",
  "updated": "text",
  "locale": "text",
  "values": [
    "text"
  ],
  "post_date": "text",
  "tags": [
    "text"
  ],
  "published_to": [
    0
  ],
  "completed_stages": [
    0
  ],
  "sets": [
    0
  ],
  "lock": "text",
  "source": "text",
  "data_source_message_id": "text",
  "allowed_privileges": [
    "text"
  ]
}