Sub Posts & Translation

Get post revisions

get

/api/v3/posts/{parent_id}/revisions

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : post_date

orderstring

Sorting parameter Available values : [ASC,DESC] !! Default value : DESC "default not working"

limitinteger · int32

Paging parameter Default value : null

offsetinteger · int32

Paging parameter Default value : 0

limitPostsinteger · int32

!!! Paging parameter to activate the limit of posts or not Default value : 0 Note: if it is true then the max value of limit is equal or less than the config (list_admin_max_limit) !!! not working , forced to be 1 in post controller

statusstring

!!! Filter parameter to set the status of posts to be returned Available values: [archived,draft,published] Default value : published Accepts multiple values: as an array or as a string but they will be separated by a comma !! if it is not set it will be published only "hard-coded"

typestring

Filter parameter to set the type of posts to be returned Available values: [report, update, revision] Default value : report

localestring

Filter parameter to set the local of posts to be returned Available values: codes returned from api v5/languages

slugstring

Filter parameter to set the local of posts to be returned

userstring

Filter parameter to set the user/users who created the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (me) as special value to return the post of the current user Special case: accept (none) as special value to return the post null value of user_id

parentstring

Filter parameter to set the parents of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (none) as special value to return the post null value of user_id

formstring

Filter parameter to set the form/forms of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (none) as special value to return the post null value of user_id

setstring

Filter parameter to set the collection/collections of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma

tagsstring

Filter parameter to set the category/categories of the posts to be returned Return Posts matching any of these Tags (Boolean OR) Accepts multiple values: as an array or as a string but they will be separated by a comma

tags[any]string

Filter parameter to set the category/categories of the posts to be returned Return Posts matching any of these Tags (Boolean OR) Accepts multiple values: as an array or as a string but they will be separated by a comma

tags[all]string

qinteger · int32

Filter parameter if this parameter is integer it will return the post with id equal the value if this parameter is string then the api will return posts containing q text in title or content properties

post_idinteger · int32

Filter parameter this parameter may used for check if a single post meets other filter conditions

created_before_by_idinteger · int32

Filter parameter to return posts before this id

created_after_by_idinteger · int32

Filter parameter to return posts after this id

created_beforestring

Date filter parameter to return posts are created before this date

created_afterstring

Date filter parameter to return posts are created after this date

updated_beforestring

Date filter parameter to return posts are updated before this date

updated_afterstring

Date filter parameter to return posts are updated after this date

date_beforestring

Date filter parameter to return posts have post-date before this date

date_afterstring

Date filter parameter to return posts have post-date after this date

bboxstring

Spatial filter parameter to set the boundaries of the posts to be returned This parameter value is (west,north,east,south)

center_pointstring

Spatial filter parameter to set the boundaries of the posts to be returned This parameter value is (lat,lng) This parameter and (within_km) parameter work together.

within_kminteger · int32

Spatial filter parameter to set the boundaries of the posts to be returned This parameter and (center_point) parameter work together.

published_tostring

Filter parameter return the posts with is published for this roles. This feature id deprecated Accepts multiple values: as an array or as a string but they will be separated by a comma

sourcestring

Filter parameter to set the sources of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma

include_typesstring

Specify values to include depending on the type Accepts multiple values: as an array or as a string but they will be separated by a comma

include_attributesstring

Specify values to include depending on the survey fields names Accepts multiple values: as an array or as a string but they will be separated by a comma

include_unmappedinteger · int32

Append unmapped totals to stats

has_locationstring

filter parameter Available values : [unmapped,mapped] Default value : id

output_core_postinteger · int32

Return results parameter if it's equal 1 then return the core fields !! but it's doesn't work now

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "count": 1,
  "limit": "1",
  "offset": 0,
  "order": "desc",
  "orderby": "post_date",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/posts/99/revisions?orderby=post_date&order=desc&limit=1&offset=0&limitPosts=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/posts/99/revisions?orderby=post_date&order=desc&limit=1&offset=1&limitPosts=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/posts/99/revisions?orderby=post_date&order=desc&limit=1&offset=0&limitPosts=0",
  "total_count": 2,
  "results": [
    {
      "id": 104,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/104",
      "type": "revision",
      "title": "Should be returned when Searching",
      "content": "Some description",
      "status": "published",
      "created": "2014-01-22T19:02:55.000Z",
      "locale": "en_us",
      "post_date": "2014-01-22T11:02:55.000Z",
      "tags": [],
      "published_to": [],
      "completed_stages": [],
      "sets": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "change_status",
        "read_full"
      ],
      "parent": {
        "id": 99,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/99"
      },
      "form": {
        "id": 1,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
      },
      "values": {
        "test_varchar": [
          "some-string"
        ]
      }
    }
  ]
}

OK

Get post revision

get

/api/v3/posts/{parent_id}/revisions/105

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions/105' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 103,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/103",
  "type": "revision",
  "title": "Should be returned when Searching",
  "slug": "555",
  "content": "Some description",
  "status": "published",
  "created": "2013-03-20T15:02:40.000Z",
  "locale": "en_us",
  "post_date": "2013-03-20T08:02:40.000Z",
  "tags": [],
  "published_to": [],
  "completed_stages": [],
  "sets": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "change_status",
    "read_full"
  ],
  "parent": {
    "id": 99,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/99"
  },
  "form": {
    "id": 1,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
  },
  "values": {
    "test_varchar": [
      "previous_string"
    ]
  }
}

OK

Get post translation

get

/api/v3/posts/{parent_id}/translations

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : post_date

orderstring

Sorting parameter Available values : [ASC,DESC] !! Default value : DESC "default not working"

limitinteger · int32

Paging parameter Default value : null

offsetinteger · int32

Paging parameter Default value : 0

limitPostsinteger · int32

!!! Paging parameter to activate the limit of posts or not Default value : 0 Note: if it is true then the max value of limit is equal or less than the config (list_admin_max_limit) !!! not working , forced to be 1 in post controller

statusstring

!!! Filter parameter to set the status of posts to be returned Available values: [archived,draft,published] Default value : published Accepts multiple values: as an array or as a string but they will be separated by a comma !! if it is not set it will be published only "hard-coded"

typestring

Filter parameter to set the type of posts to be returned Available values: [report, update, revision] Default value : report

localestring

Filter parameter to set the local of posts to be returned Available values: codes returned from api v5/languages

slugstring

Filter parameter to set the local of posts to be returned

userstring

Filter parameter to set the user/users who created the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (me) as special value to return the post of the current user Special case: accept (none) as special value to return the post null value of user_id

parentstring

Filter parameter to set the parents of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (none) as special value to return the post null value of user_id

formstring

Filter parameter to set the form/forms of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma Special case: accept (none) as special value to return the post null value of user_id

setstring

Filter parameter to set the collection/collections of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma

tagsstring

Filter parameter to set the category/categories of the posts to be returned Return Posts matching any of these Tags (Boolean OR) Accepts multiple values: as an array or as a string but they will be separated by a comma

tags[any]string

Filter parameter to set the category/categories of the posts to be returned Return Posts matching any of these Tags (Boolean OR) Accepts multiple values: as an array or as a string but they will be separated by a comma

tags[all]string

qinteger · int32

Filter parameter if this parameter is integer it will return the post with id equal the value if this parameter is string then the api will return posts containing q text in title or content properties

post_idinteger · int32

Filter parameter this parameter may used for check if a single post meets other filter conditions

created_before_by_idinteger · int32

Filter parameter to return posts before this id

created_after_by_idinteger · int32

Filter parameter to return posts after this id

created_beforestring

Date filter parameter to return posts are created before this date

created_afterstring

Date filter parameter to return posts are created after this date

updated_beforestring

Date filter parameter to return posts are updated before this date

updated_afterstring

Date filter parameter to return posts are updated after this date

date_beforestring

Date filter parameter to return posts have post-date before this date

date_afterstring

Date filter parameter to return posts have post-date after this date

bboxstring

Spatial filter parameter to set the boundaries of the posts to be returned This parameter value is (west,north,east,south)

center_pointstring

Spatial filter parameter to set the boundaries of the posts to be returned This parameter value is (lat,lng) This parameter and (within_km) parameter work together.

within_kminteger · int32

Spatial filter parameter to set the boundaries of the posts to be returned This parameter and (center_point) parameter work together.

published_tostring

Filter parameter return the posts with is published for this roles. This feature id deprecated Accepts multiple values: as an array or as a string but they will be separated by a comma

sourcestring

Filter parameter to set the sources of the posts to be returned Accepts multiple values: as an array or as a string but they will be separated by a comma

include_typesstring

Specify values to include depending on the type Accepts multiple values: as an array or as a string but they will be separated by a comma

include_attributesstring

Specify values to include depending on the survey fields names Accepts multiple values: as an array or as a string but they will be separated by a comma

include_unmappedinteger · int32

Append unmapped totals to stats

has_locationstring

filter parameter Available values : [unmapped,mapped] Default value : id

output_core_postinteger · int32

Return results parameter if it's equal 1 then return the core fields !! but it's doesn't work now

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "count": 1,
  "offset": 0,
  "order": "desc",
  "orderby": "post_date",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105/translations?orderby=post_date&order=desc&offset=0&limitPosts=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105/translations?orderby=post_date&order=desc&offset=0&limitPosts=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105/translations?orderby=post_date&order=desc&offset=0&limitPosts=0",
  "total_count": 1,
  "results": [
    {
      "id": 106,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/106",
      "type": "translation",
      "title": "French post",
      "content": "Some description",
      "status": "published",
      "created": "2014-08-16T05:09:11.000Z",
      "locale": "fr_fr",
      "post_date": "2014-08-15T22:09:11.000Z",
      "tags": [],
      "published_to": [],
      "completed_stages": [],
      "sets": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "change_status",
        "read_full"
      ],
      "parent": {
        "id": 105,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105"
      },
      "form": {
        "id": 1,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
      },
      "values": {
        "test_varchar": [
          "some-string",
          "french string"
        ]
      }
    }
  ]
}

OK

Get post translation

get

/api/v3/posts/{parent_id}/translations/{translation_id}

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

translation_idstringrequired

Translation indentifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/{translation_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 106,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/106",
  "type": "translation",
  "title": "French post",
  "content": "Some description",
  "status": "published",
  "created": "2014-08-16T05:09:11.000Z",
  "locale": "fr_fr",
  "post_date": "2014-08-15T22:09:11.000Z",
  "tags": [],
  "published_to": [],
  "completed_stages": [],
  "sets": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "change_status",
    "read_full"
  ],
  "parent": {
    "id": 105,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105"
  },
  "form": {
    "id": 1,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
  },
  "values": {
    "test_varchar": [
      "some-string",
      "french string"
    ]
  }
}

OK

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

delete

/api/v3/posts/{parent_id}/translations/{translation_id}

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

translation_idstringrequired

Translation indentifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/{translation_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 106,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/106",
  "type": "translation",
  "title": "French post",
  "content": "Some description",
  "status": "published",
  "created": "2014-08-16T05:09:11.000Z",
  "locale": "fr_fr",
  "post_date": "2014-08-15T22:09:11.000Z",
  "tags": [],
  "published_to": [],
  "completed_stages": [],
  "sets": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "change_status",
    "read_full"
  ],
  "parent": {
    "id": 105,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105"
  },
  "form": {
    "id": 1,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
  },
  "values": {
    "test_varchar": [
      "some-string",
      "french string"
    ]
  }
}

OK

Get post local translation

get

/api/v3/posts/{parent_id}/translations/(local)

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/(local)' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 108,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/108",
  "type": "translation",
  "title": "Arabic post",
  "content": "Some description",
  "status": "published",
  "created": "2014-06-30T00:56:31.000Z",
  "locale": "ar_ar",
  "post_date": "2014-06-29T17:56:31.000Z",
  "tags": [],
  "published_to": [],
  "completed_stages": [],
  "sets": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "change_status",
    "read_full"
  ],
  "parent": {
    "id": 105,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/105"
  },
  "form": {
    "id": 1,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
  },
  "values": {
    "test_varchar": [
      "arabic string"
    ]
  }
}

OK

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

delete

/api/v3/posts/{parent_id}/translations/(local)

Authorizations

Path parameters

parent_idstringrequired

Parent Identifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/translations/(local)' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 101,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/101",
  "type": "translation",
  "title": "Not a child report anymore",
  "content": "Some description",
  "status": "published",
  "created": "2013-03-08T13:04:55.000Z",
  "locale": "fr_fr",
  "post_date": "2013-03-08T05:04:55.000Z",
  "tags": [],
  "published_to": [],
  "completed_stages": [],
  "sets": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "change_status",
    "read_full"
  ],
  "parent": {
    "id": 96,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/posts/96"
  },
  "form": {
    "id": 1,
    "url": "https://ushahididocs.api.ushahidi.io//api/v3/forms/1"
  },
  "values": {
    "test_varchar": [
      "dummy string"
    ]
  }
}

OK