Elentra API
  • Introduction
  • Developers
    • Getting Started
    • Quickstart Guide
      • Set up Repositories
      • Validate the setup
      • Exploring the API
      • Creating a new Module
      • Setup Routing
      • Introduction to Postman
      • Create a Controller
      • Using Eloquent Models
      • Input Validation
      • API Resource Authorization
  • Elentra API Standards
    • HTTP Methods & Status Codes
    • Routing & Parameters
      • Example Routing Patterns with HTTP Method
        • /courses/{course}/contacts
        • /courses/{course}/contacts?type={contact_type}
        • /courses/{course}/contacts/{contact}
        • /courses/{course}/syllabus
      • Common Mistakes
        • [GET] /admissions/file-review/file/rubric-score/{cycle_id}/{pool_id}/{subpool_id}
        • [DELETE] /notices/1,2,3
        • [GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth
        • [GET] /admissions/file-review/file/rubric-score/delete/{id}
        • [GET] /portfolio/entries/{entry_id}/get-file
        • [POST] /cbe/curriculum/updateframework
  • Automated Testing
    • Getting Started
      • Setting up a testing environment
      • Running Automated Tests
    • Seed Data
      • Folder Structure
      • Creating Seed Data
    • Functional Tests
      • Creating a Functional Test File
      • Testing HTTP Verbs
        • Creating an HTTP Test
        • GET Requests
        • POST / PUT / DELETE Requests
        • GraphQL Requests
      • Asserting API Response
      • Annotations
    • Code Style Linting
Powered by GitBook
On this page
  1. Elentra API Standards
  2. Routing & Parameters
  3. Common Mistakes

[GET] /admissions/file-review/file/rubric-score/{cycle_id}/{pool_id}/{subpool_id}

  • Ambiguous route parameters.

  • The relationship between entities is not well defined.

    • Lacking structural sub-collections.

  • "file-review" is being used as a sub-namespace, not a resource or a collection.

  • Target resource "rubric-score" proceeds the sub-resources.

  • Difficult to read the URI.

  • Remove "file-review".

    • It's not a collection or resource.

    • /admissions/file-reviews or /admissions/reviews

  • rubric-score should be moved to the end of the route.

  • cycle/pool/subpool needs to be denominated by their respective sub-collections.

    • /cycles/{cycle}/pools/{pool}/subpools/{subpool}

Final Suggestion

[GET] /admissions/review/cycles/{cycle}/pools/{pool}/subpools/{subpool}/file/rubric-score/

If there are too many parameters in the route, consider flattening it using query parameters.

[GET] /admissions/files/{file}/review/rubric/{rubric}/scores?cycle=&pool=&subpool=

PreviousCommon MistakesNext[DELETE] /notices/1,2,3

Last updated 2 years ago