dfe-digital / sdd-technical-documentation

SDD Technical Documentation

This repository is intended to provide a central point for technical reference for services specific to SDD.

Architecture Decision Records

Details how and why we have chosen to our SDD specific architecture.

Development Guidance

Documentation covering the ways our development teams work and the technical standards we work against.

This set of documentation is division specific, we base our standards on DfE Digital Guidance, any areas not covered by the DfE Digital guidance or contradictory to this documentation, we take this set of documentation as precedent.

TRAMS API Document

The TRAMS (Trust and Academy Management System) system acts as a data source for SDD's digital services supporting Academies and Free Schools. We're working on a set of RESTful APIs to allow digital services to consume data from TRAMS and to feed back data necessary for completing projects.

The document is maintained here as a central contract so systems can develop against a consistent API while it is in development. It's generated and viewable using (Swagger)[swagger.io]

Use docker run -d -p 80:8080 -v $(pwd):/tmp -e SWAGGER_FILE=/tmp/trams_api_spec/trams_api_spec.yaml swaggerapi/swagger-editor to run the editor with the trams api spec pre loaded, on localhost:80

sdd-technical-documentation's Issues

Feature request: Searching for Trusts

Context

For the Academy Transfers project user research has shown that users search for trusts using one of three bits of information:

• The 'Trust reference number'
• The name of the trust
• The companies house number

For usability we've combined these searches into one input as shown here:

Requirements

General

This request should be paginated

Request

An endpoint that allows us to search by:

• The 'Trust reference number'
• The name of the trust
• The companies house number

Ideally, being able to search against all three at once using our single input would help with development and reduce the number of requests made to the API

Response

An array of the matching trusts