This repo models a process allowing external guidance authors, approvers and publishers to make guidance available to the public. The service is provided in the English language.

This code is open source software licensed under the Apache 2.0 License.

Allows Ocelot to send over a scratch process and check how it looks in the browser. The generated ID is returned to the caller, with a location header enabling the user to be redirected to view the submitted process.

This is the json string representing the Ocelot process

HTTP Status: 201

Headers:

location -> "/guidance/scratch/:id"

Example Response Body:

{
   "id": "265e0178-cbe1-42ab-8418-7120ce6d0925"
}

Error response format

{
   "code": "ERROR_CODE",
   "message": "Human readable error message"
}

400

BAD_REQUEST

500

INTERNAL_SERVER_ERROR

Allows Ocelot to send over a process and make it available for Fact Checking The ocelot ID is returned to the caller.

This is the json string representing the Ocelot process

HTTP Status: 201

Example Response Body:

{
   "id": "oct90005"
}

Error response format

{
   "code": "ERROR_CODE",
   "message": "Human readable error message"
}

400

BAD_REQUEST

500

INTERNAL_SERVER_ERROR

Allows Ocelot to send over a process and make it available for a 2i Review The ocelot ID is returned to the caller.

This is the json string representing the Ocelot process

HTTP Status: 201

Example Response Body:

{
   "id": "oct90005"
}

Error response format

{
   "code": "ERROR_CODE",
   "message": "Human readable error message"
}

400

BAD_REQUEST

500

INTERNAL_SERVER_ERROR