CSV

get all csv

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

Query parameters

Response

200401

OK

Body

application/json

count*integer (int32)

results*array of getallcsv_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurl

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

Response

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

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

200: OK

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

200: OK

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

GEThttps://ushahididocs.api.ushahidi.io/api/v3/csv/20

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

columns*array of string

maps_to*nullable string

fixed*nullable string

filename*string

mime*string

size*integer (int32)

created*string

updated*nullable string

completed*nullable string

status*nullable string

errors*nullable string

processed*nullable string

collection_id*nullable string

allowed_privileges*array of string

Request

JavaScriptCurl

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

Response

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

deletecsv

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/csv/1

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

columns*array of string

maps_to*nullable string

fixed*nullable string

filename*string

mime*string

size*integer (int32)

created*string

updated*nullable string

completed*nullable string

status*nullable string

errors*nullable string

processed*nullable string

collection_id*nullable string

allowed_privileges*array of string

Request

JavaScriptCurl

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

Response

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

import csv

POSThttps://ushahididocs.api.ushahidi.io/api/v3/csv/2/import

Response

200

Request

JavaScriptCurl

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