{"version":1,"pages":[{"id":"-LHoHzzzpjSOvQApFUoM","title":"Introduction","pathname":"/api","siteSpaceId":"sitesp_v4xGP","description":""},{"id":"-LMk7f1M8OGCdUOl10qO","title":"Getting Started","pathname":"/api/developers/getting-started","siteSpaceId":"sitesp_v4xGP","description":"The developer documentation you need to getting started with the Elentra API.","breadcrumbs":[{"label":"Developers"}]},{"id":"-LMk7p52R8qSNQWKpYeC","title":"Quickstart Guide","pathname":"/api/developers/quickstart-guide","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"}]},{"id":"-LMkAQ-8nF7uh0YjEXVE","title":"Set up Repositories","pathname":"/api/developers/quickstart-guide/untitled","siteSpaceId":"sitesp_v4xGP","description":"Clone the repositories and link them together for development","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMo2-KZ6cHQT6N92SDD","title":"Validate the setup","pathname":"/api/developers/quickstart-guide/validate-the-setup","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMo8DWpjiGVLkmIAcxX","title":"Exploring the API","pathname":"/api/developers/quickstart-guide/exploring-the-api","siteSpaceId":"sitesp_v4xGP","description":"A quick guide to the parts of the API folder heirarchy","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMoA1-7EcnH7aBk2REo","title":"Creating a new Module","pathname":"/api/developers/quickstart-guide/creating-a-new-module","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMoApK36OIS2PfS89Go","title":"Setup Routing","pathname":"/api/developers/quickstart-guide/creating-routes-and-controllers","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMxBmg7fSe89ts212sz","title":"Introduction to Postman","pathname":"/api/developers/quickstart-guide/postman","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMx0QFe9U31JUXXLmCE","title":"Create a Controller","pathname":"/api/developers/quickstart-guide/create-a-controller","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMoAM_tcE8iBYOeeCYm","title":"Using Eloquent Models","pathname":"/api/developers/quickstart-guide/using-eloquent-models","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LMoAnQo5LaQO0QenFch","title":"Input Validation","pathname":"/api/developers/quickstart-guide/input-validation","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"-LtfhWZ0yiKXKDRgLTN2","title":"API Resource Authorization","pathname":"/api/developers/quickstart-guide/authorization","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Developers"},{"label":"Quickstart Guide"}]},{"id":"qGX2afh2xwH8kAWPxVsf","title":"HTTP Methods & Status Codes","pathname":"/api/elentra-api-standards/http-methods-and-status-codes","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"}]},{"id":"p6DL0EWseKdlex6TWZ5i","title":"Routing & Parameters","pathname":"/api/elentra-api-standards/routing-and-parameters","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"}]},{"id":"czLlQZqdT5YrohVlNbzX","title":"Example Routing Patterns with HTTP Method","pathname":"/api/elentra-api-standards/routing-and-parameters/example-routing-patterns-with-http-method","siteSpaceId":"sitesp_v4xGP","description":"Examples of how to construct a Uniform Resource Identifier (URI).","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"}]},{"id":"ywX9I4FSb7WFJd4vaEYV","title":"/courses/{course}/contacts","pathname":"/api/elentra-api-standards/routing-and-parameters/example-routing-patterns-with-http-method/courses-course-contacts","siteSpaceId":"sitesp_v4xGP","description":"Collection/Resource/Sub-Collection","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Example Routing Patterns with HTTP Method"}]},{"id":"CCtMCxPb142mE5jUkDkG","title":"/courses/{course}/contacts?type={contact_type}","pathname":"/api/elentra-api-standards/routing-and-parameters/example-routing-patterns-with-http-method/courses-course-contacts-type-contact_type","siteSpaceId":"sitesp_v4xGP","description":"Collection/Resource/Sub-Collection?Query","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Example Routing Patterns with HTTP Method"}]},{"id":"hBnEnSAw5uqgiCDad3yE","title":"/courses/{course}/contacts/{contact}","pathname":"/api/elentra-api-standards/routing-and-parameters/example-routing-patterns-with-http-method/courses-course-contacts-contact","siteSpaceId":"sitesp_v4xGP","description":"Collection/Resource/Sub-Collection/Sub-Resource","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Example Routing Patterns with HTTP Method"}]},{"id":"i0qkoijE0qk0xcmlJHKF","title":"/courses/{course}/syllabus","pathname":"/api/elentra-api-standards/routing-and-parameters/example-routing-patterns-with-http-method/courses-course-syllabus","siteSpaceId":"sitesp_v4xGP","description":"Collection/Resource/Sub-Resource","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Example Routing Patterns with HTTP Method"}]},{"id":"izwWondCowYpEynRXMys","title":"Common Mistakes","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes","siteSpaceId":"sitesp_v4xGP","description":"Examples of common mistakes in the Elentra API with suggestions of how readability could be improved by applying RESTful best practices.","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"}]},{"id":"3L1CyiZPd7XBiL4uEdL8","title":"[GET] /admissions/file-review/file/rubric-score/{cycle_id}/{pool_id}/{subpool_id}","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/get-admissions-file-review-file-rubric-score-cycle_id-pool_id-subpool_id","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"x33pUrBePNDakEj9WQdT","title":"[DELETE] /notices/1,2,3","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/delete-notices-1-2-3","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"xf110hPG0eyaInF3TUdG","title":"[GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/get-cbe-curriculum-framework-framework_id-hierarchy-by-depth","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"fXI4YsKFNDm27RJt7oIW","title":"[GET] /admissions/file-review/file/rubric-score/delete/{id}","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/get-admissions-file-review-file-rubric-score-delete-id","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"Rs2MOCuufvYWFxNyD0Y5","title":"[GET] /portfolio/entries/{entry_id}/get-file","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/get-portfolio-entries-entry_id-get-file","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"OSxgcBYa3KOlbswGY6EF","title":"[POST] /cbe/curriculum/updateframework","pathname":"/api/elentra-api-standards/routing-and-parameters/common-mistakes/post-cbe-curriculum-updateframework","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Elentra API Standards"},{"label":"Routing & Parameters"},{"label":"Common Mistakes"}]},{"id":"wsjkcfD27LUoOj16DAhv","title":"Getting Started","pathname":"/api/automated-testing/getting-started","siteSpaceId":"sitesp_v4xGP","description":"This section is on how to run, create and edit automated tests for the Elentra API repository.","breadcrumbs":[{"label":"Automated Testing"}]},{"id":"jiQxFjSnqqVWnnGdJVv2","title":"Setting up a testing environment","pathname":"/api/automated-testing/getting-started/setting-up-a-testing-environment","siteSpaceId":"sitesp_v4xGP","description":"Steps on how to setup a testing environment to run the API automated tests","breadcrumbs":[{"label":"Automated Testing"},{"label":"Getting Started"}]},{"id":"CvtBpLO44VAs2sZPGxp3","title":"Running Automated Tests","pathname":"/api/automated-testing/getting-started/running-automated-tests","siteSpaceId":"sitesp_v4xGP","description":"The page demostrates the mutliple ways to run the automated functional tests for the API","breadcrumbs":[{"label":"Automated Testing"},{"label":"Getting Started"}]},{"id":"ggEQht5Kx1lri2LjIk39","title":"Seed Data","pathname":"/api/automated-testing/seed-data","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"}]},{"id":"vfrv9MegqPRGcnI1voNF","title":"Folder Structure","pathname":"/api/automated-testing/seed-data/folder-structure","siteSpaceId":"sitesp_v4xGP","description":"Functional tests require data already populated in the database for the endpoints to return a response. Seed data allows pre-determined data to be populated in the database, allowing accurate asserts.","breadcrumbs":[{"label":"Automated Testing"},{"label":"Seed Data"}]},{"id":"9h7z7D1kNdOkl5jNpJm1","title":"Creating Seed Data","pathname":"/api/automated-testing/seed-data/creating-seed-data","siteSpaceId":"sitesp_v4xGP","description":"Steps in creating a new seed data file","breadcrumbs":[{"label":"Automated Testing"},{"label":"Seed Data"}]},{"id":"6w8ePtNsQWIcGNSVl7AE","title":"Functional Tests","pathname":"/api/automated-testing/functional-tests","siteSpaceId":"sitesp_v4xGP","description":"Functional tests are any tests in which the end user interacts with the application. In the case of the API","breadcrumbs":[{"label":"Automated Testing"}]},{"id":"pfe0uQYApYmGxgpzSNnE","title":"Creating a Functional Test File","pathname":"/api/automated-testing/functional-tests/creating-a-functional-test-file","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"}]},{"id":"lGGUCgIDoDInQMp9FMkj","title":"Testing HTTP Verbs","pathname":"/api/automated-testing/functional-tests/testing-http-verbs","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"}]},{"id":"wm7uyDTelEMWZIvFu5b1","title":"Creating an HTTP Test","pathname":"/api/automated-testing/functional-tests/testing-http-verbs/creating-an-http-test","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"},{"label":"Testing HTTP Verbs"}]},{"id":"hlhq0rZQOA7TcnVCSxLI","title":"GET Requests","pathname":"/api/automated-testing/functional-tests/testing-http-verbs/get-requests","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"},{"label":"Testing HTTP Verbs"}]},{"id":"iy6PrJvEYCXipG2b0Ws6","title":"POST / PUT / DELETE Requests","pathname":"/api/automated-testing/functional-tests/testing-http-verbs/post-put-delete-requests","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"},{"label":"Testing HTTP Verbs"}]},{"id":"LA4mZEdtd0j3eC2kyayL","title":"GraphQL Requests","pathname":"/api/automated-testing/functional-tests/testing-http-verbs/graphql-requests","siteSpaceId":"sitesp_v4xGP","description":"","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"},{"label":"Testing HTTP Verbs"}]},{"id":"bIsmpQdMfrP2bT4sH9bF","title":"Asserting API Response","pathname":"/api/automated-testing/functional-tests/asserting-api-response","siteSpaceId":"sitesp_v4xGP","description":"Automation tests are only validating if they assert the expected results. Asserts are used to verify the expected results from the endpoint.","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"}]},{"id":"evarchRRHJfS84uK05Jm","title":"Annotations","pathname":"/api/automated-testing/functional-tests/annotations","siteSpaceId":"sitesp_v4xGP","description":"Elentra's API contains custom annotations for functional tests that help developers easily create and manage tests.","breadcrumbs":[{"label":"Automated Testing"},{"label":"Functional Tests"}]},{"id":"4D5YNNeiYt14uwAjDeAJ","title":"Code Style Linting","pathname":"/api/automated-testing/code-style-linting","siteSpaceId":"sitesp_v4xGP","description":"Elentra API uses php-cs-fixer to verify that code styles are enforced.","breadcrumbs":[{"label":"Automated Testing"}]}]}