Resources API

GET /api/resources

Retrieve a list of all resources, documents, and reports related to Dzaleka Refugee Camp.

Query Parameters

This endpoint does not require any query parameters.

Response Format

string

required

Status of the API response (“success” or “error”)

number

required

Total number of resources returned

object

required

Container for the resources data

array

required

Array of resource objects

string

Unique identifier for the resource

string

Collection name (“resources”)

string

Resource title

string

Resource description

string

Publication or creation date (YYYY-MM-DD)

string

Resource category (e.g., “Situation Reports / Updates”, “Guidelines”, “Research”)

string

File type (e.g., “pdf”, “doc”, “xlsx”)

string

URL to view the resource online

string

Direct download URL

string

File size (e.g., “748.24 KB”, “2.5 MB”)

string

Last update date (YYYY-MM-DD)

array

Array of available languages

boolean

Whether the resource is featured

string

Author or publishing organization

Error Responses

string

“error”

string

Error message description

string

Detailed error information

Status Codes:

200 - Success
429 - Rate limit exceeded (60 requests per minute)
500 - Internal server error

Rate Limiting

All API endpoints are rate-limited to 60 requests per minute per IP address. Rate limit headers are included in responses:

X-RateLimit-Limit: Maximum requests per window
X-RateLimit-Remaining: Remaining requests in current window
X-RateLimit-Reset: Timestamp when the rate limit resets
Retry-After: Seconds to wait before retrying (only on 429 responses)

Example Request

curl -X GET "https://services.dzaleka.com/api/resources" \
  -H "Content-Type: application/json"

Example Response

{
  "status": "success",
  "count": 1,
  "data": {
    "resources": [
      {
        "id": "Banking-services-in-Dzaleka-Refugee-Camp",
        "collection": "resources",
        "title": "Banking services in Dzaleka Refugee Camp",
        "description": "New Finance Bank opened its branch of service in Dzaleka Refugee Camp on 12 April 2018.",
        "date": "2019-03-01",
        "category": "Situation Reports / Updates",
        "fileType": "pdf",
        "resourceUrl": "https://data.unhcr.org/en/documents/details/68623",
        "downloadUrl": "https://data.unhcr.org/en/documents/download/68623",
        "fileSize": "748.24 KB",
        "lastUpdated": "2024-12-27",
        "languages": ["English"],
        "featured": false,
        "author": "UNHCR Malawi"
      }
    ]
  }
}

POST /api/resources

Retrieve resources data with optional metadata and statistics.

Request Body

object

Optional configuration for the response

boolean

Include export metadata in response

boolean

Include statistics in response

Response Format

Same as GET endpoint, with optional additional fields:

object

Export metadata (only if includeMetadata: true)

string

ISO 8601 timestamp of export

string

Collection name

object

Statistics (only if includeStats: true)

number

Total number of items

string

Collection name

Example Request

curl -X POST "https://services.dzaleka.com/api/resources" \
  -H "Content-Type: application/json" \
  -d '{
    "options": {
      "includeMetadata": true,
      "includeStats": true
    }
  }'

Example Response

{
  "status": "success",
  "count": 156,
  "data": {
    "resources": [
      {
        "id": "Banking-services-in-Dzaleka-Refugee-Camp",
        "title": "Banking services in Dzaleka Refugee Camp",
        "category": "Situation Reports / Updates",
        "fileType": "pdf",
        "author": "UNHCR Malawi"
      }
    ]
  },
  "metadata": {
    "exportDate": "2025-03-09T12:00:00.000Z",
    "collection": "resources"
  },
  "stats": {
    "totalItems": 156,
    "collection": "resources"
  }
}

Implementation

The Resources API is implemented using the createGetHandler and createPostHandler utility functions from src/utils/api-utils.ts:118. Source code: src/pages/api/resources.ts:5

Getting Started

Endpoints

Data Models

GET /api/resources

Query Parameters

Response Format

Error Responses

Rate Limiting

Example Request

Example Response

POST /api/resources

Request Body

Response Format

Example Request

Example Response

Implementation

​GET /api/resources

​Query Parameters

​Response Format

​Error Responses

​Rate Limiting

​Example Request

​Example Response

​POST /api/resources

​Request Body

​Response Format

​Example Request

​Example Response

​Implementation

GET /api/resources

Query Parameters

Response Format

Error Responses

Rate Limiting

Example Request

Example Response

POST /api/resources

Request Body

Response Format

Example Request

Example Response

Implementation