CSV | v3 Ushahidi Platform REST API Documentation

v3 Ushahidi Platform REST API Documentation

add csv

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

Request Body

Name

Type

Description

file

String

CSV file

size

String

CSV file size

{
    "id": 1,
    "url": "http://localhost:8000/api/v3/csv/1",
    "columns": [
        "col1,col2"
    ],
    "maps_to": null,
    "fixed": null,
    "filename": "file.csv",
    "mime": "csv",
    "size": 22,
    "created": "1970-01-01T00:00:00+00:00",
    "updated": "2022-11-03T23:14:31+00:00",
    "completed": null,
    "status": null,
    "errors": null,
    "processed": null,
    "collection_id": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

add csv

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

Request Body

Name

Type

Description

file

String

CSV file

size

String

CSV file size

{
    "id": 1,
    "url": "http://localhost:8000/api/v3/csv/1",
    "columns": [
        "col1,col2"
    ],
    "maps_to": null,
    "fixed": null,
    "filename": "file.csv",
    "mime": "csv",
    "size": 22,
    "created": "1970-01-01T00:00:00+00:00",
    "updated": "2022-11-03T23:14:31+00:00",
    "completed": null,
    "status": null,
    "errors": null,
    "processed": null,
    "collection_id": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

get all csv

get

/api/v3/csv

Authorizations

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : id

Example: id

orderstring

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

Example: Desc

limitinteger · int32

Paging parameter Default value : null

Example: 2

offsetinteger · int32

Paging parameter Default value : 0

Example: 3

columnsstring

Filter parameter check the columns value

Example: col1,col2

maps_tointeger · int32

Filter parameter check the maps_to value

Example: 2

fixedinteger · int32

Filter parameter check the fixed value

Example: 1

filenamestring

Filter parameter check the filename value

Example: file.csv

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/csv' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "url": "http://localhost:8000/api/v3/csv/1",
      "columns": [
        "col1,col2"
      ],
      "filename": "file.csv",
      "mime": "csv",
      "size": 200,
      "created": "1970-01-01T00:00:00+00:00",
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "http://localhost:8000/api/v3/csv?orderby=id&order=asc&offset=0",
  "next": "http://localhost:8000/api/v3/csv?orderby=id&order=asc&offset=0",
  "prev": "http://localhost:8000/api/v3/csv?orderby=id&order=asc&offset=0",
  "total_count": 1
}

OK

get csv

get

/api/v3/csv/20

Authorizations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/csv/20' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

{
  "id": 2,
  "url": "http://localhost:8000/api/v3/csv/2",
  "columns": [
    "col3,col4"
  ],
  "filename": "file.csv",
  "mime": "csv",
  "size": 100,
  "created": "1970-01-01T00:00:00+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

OK

deletecsv

delete

/api/v3/csv/1

Authorizations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/csv/1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

{
  "id": 2,
  "url": "http://localhost:8000/api/v3/csv/2",
  "columns": [
    "col3,col4"
  ],
  "filename": "file.csv",
  "mime": "csv",
  "size": 100,
  "created": "1970-01-01T00:00:00+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

OK

import csv

post

/api/v3/csv/2/import

Authorizations

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/csv/2/import' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

No body