Skip to main content

Getting Started

Welcome to the documentation for the Domestic on Demand (DoD) solution. If you are not yet engaged with OCAS on starting to transition to Domestic on Demand would like more information, please contact OCAS.

If you are ready to start development to integrate with DoD, you can start to examine the details of the APIs and event models in the solution.

As documentation is in progress it may be valuable to refer to the current published Coltrane specification for clarity on some lookups and element values.

Background

For some time, colleges have asked OCAS to look at better ways of sending them applicant data. The existing Coltrane service uses dated technology that is fairly inflexible and requires significant efforts to change. It is also limiting as to how quickly colleges are able to get applicant data and respond with offers of admission.

Overview

The DoD service consists of a two-way API that allows for exchange of application data and offers. As updates occur on a paid application, that data is available for the College to retrieve and consume. The College can also send offers of admission to the applicant and they are made available to the applicant in real-time.

Benefits & Scenarios

The DoD API provides a number of benefits over the existing Coltrane service, including:

  • Retrieve applicant data at any frequency
  • Send offers at any time
  • Consume data for a particular application independent of other applications
  • Retrieve full application record at any time through self-service, to address sync issues etc.
  • Authenticated document download
  • Add data elements without introducing breaking changes

Components

Under the hood, the DoD API plugs into the existing infrastructure of the Domestic Apply service without changing the existing application process or applicant experience. It maintains its own store of event data as events are published.

Requesting API Access

In order to access any of the Domestic on Demand API environments you will need to have been issued credentials that your solution will use to request a Bearer token for request authorization.

OCAS will provide you information about the location of the OIDS and credentials for development purposes in a separate e-mail. If you do not yet have this information please have a representative from your college reach out to the OCAS Customer Success team.

Generating an API Client

To help integrate with the Domestic on Demand API there is an API Reference [UAT | PROD] provided by the API itself using an OpenAPI specification document. You can retrieve the specification document for the purposes of importing into a development platform and possibly generating code. Some examples of useful tools for this purpose are: