Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] API - List Indicators #156

Open
janbur opened this issue Nov 29, 2023 · 1 comment · May be fixed by #172
Open

[Feature Request] API - List Indicators #156

janbur opened this issue Nov 29, 2023 · 1 comment · May be fixed by #172
Labels
Back-end 🕗 5 - 8 hours It will take between half a day and a full day.

Comments

@janbur
Copy link
Collaborator

janbur commented Nov 29, 2023

This is the child of: #151

Current API docs: https://geosight.unicef.org/api/v1/docs/

Objective

Create a new API endpoint for listing indicators available in GeoSight and listing the full details of a specific indicator.

Implementation

GET /api/v1/indicators/

  • 📒 Description:
    • A paginated list of indicator.
  • ⬇️ Parameters:
    • name_contains={string}
    • description_contains={string}
    • shortcode_contains={string}
    • created_by_contains={string}
    • project_slug={project_slug}
    • project_id={project_id}
    • ...
  • ⬆️ Returns:
    • results {array}:
      • id
      • name
      • description
      • shortcode
      • type
    • count - number of records
    • page - current page
    • page_count - count of pages
    • next - number of next page
    • previous - number of previous page

GET /api/v1/indicators/{id}/

  • 📒 Description:
    • A detailed indicator.
  • ⬇️ Parameters:
    • none
  • ⬆️ Returns:
    • name (string),
    • description (string),
    • source (string),
    • short_code (string),
    • category (string),
    • units (string),
    • type (int, float, category),
    • value_min (for int and float types),
    • value_max (for int and float types),
    • code_list_id (for "category" type only)
@janbur janbur changed the title [Feature Request] List Indicators [Feature Request] API - List Indicators Nov 29, 2023
@janbur janbur added 🕗 5 - 8 hours It will take between half a day and a full day. Back-end labels Nov 30, 2023
@Thuhaa Thuhaa linked a pull request Dec 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Back-end 🕗 5 - 8 hours It will take between half a day and a full day.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants