Data provider

Get data providers

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

Query parameters

Response

200401

OK

Body

application/json

countinteger

resultsarray of DataProviderResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurl

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

Response

{
  "results": [
    {
      "id": "text",
      "url": "text",
      "name": "text",
      "services": [
        "text"
      ],
      "options": {
        "intro_text": {
          "label": "text",
          "input": "text",
          "description": "text"
        },
        "incoming_type": {
          "label": "text",
          "input": "text",
          "description": "text",
          "option": [
            "text"
          ],
          "rules": [
            "text"
          ]
        },
        "incoming_server": {
          "label": "text",
          "input": "text",
          "description": "text",
          "rules": [
            "text"
          ]
        },
        "incoming_port": {
          "label": "text",
          "input": "text",
          "description": "text",
          "rules": [
            "text"
          ]
        },
        "incoming_security": {
          "label": "text",
          "input": "text",
          "description": "text",
          "options": [
            "text"
          ]
        },
        "incoming_username": {
          "label": "text",
          "input": "text",
          "description": "text",
          "placeholder": "text",
          "rules": [
            "text"
          ]
        },
        "incoming_password": {
          "label": "text",
          "input": "text",
          "description": "text",
          "placeholder": "text",
          "rules": [
            "text"
          ]
        }
      },
      "inbound_fields": {
        "Subject": "text",
        "Date": "text",
        "Message": "text",
        "allowed_privileges": [
          "text"
        ]
      }
    }
  ],
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text"
}

Get data provider

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

Response

200401404

OK

Body

application/json

idstring

urlstring

namestring

servicesarray of string

optionsDataProviderResponseList_options (object)

inbound_fieldsDataProviderResponseList_inbound_fields (object)

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "url": "text",
  "name": "text",
  "services": [
    "text"
  ],
  "options": {
    "intro_text": {
      "label": "text",
      "input": "text",
      "description": "text"
    },
    "incoming_type": {
      "label": "text",
      "input": "text",
      "description": "text",
      "option": [
        "text"
      ],
      "rules": [
        "text"
      ]
    },
    "incoming_server": {
      "label": "text",
      "input": "text",
      "description": "text",
      "rules": [
        "text"
      ]
    },
    "incoming_port": {
      "label": "text",
      "input": "text",
      "description": "text",
      "rules": [
        "text"
      ]
    },
    "incoming_security": {
      "label": "text",
      "input": "text",
      "description": "text",
      "options": [
        "text"
      ]
    },
    "incoming_username": {
      "label": "text",
      "input": "text",
      "description": "text",
      "placeholder": "text",
      "rules": [
        "text"
      ]
    },
    "incoming_password": {
      "label": "text",
      "input": "text",
      "description": "text",
      "placeholder": "text",
      "rules": [
        "text"
      ]
    }
  },
  "inbound_fields": {
    "Subject": "text",
    "Date": "text",
    "Message": "text",
    "allowed_privileges": [
      "text"
    ]
  }
}