Home

Introduction

The Prime API is a subset of the MilMove API that makes it possible for the Prime contractor to consume and update data related to move orders.

It is a RESTful API that accepts JSON-encoded request bodies and returns JSON-encoded responses. It uses standard HTTP response codes and verbs, and mutual TLS for authentication.

The API consists of the prime and support endpoints. The prime endpoints will be used in production. The support endpoints provide additional functionality for testing and are not available in production.

The supported production interactions can be seen in the sequence diagram.

The Prime API uses the Swagger 2.0 specification. Swagger allows developers to define what their API will look like and easily provide documentation in a human-readable format.

This wiki contains documentation on the latest version of the Prime API, Milestone 3.

Web links

You can view the documentation from master directly using these links.

• Milmove Prime API Documentation
• Milmove Support API Documentation

First steps

The Getting Started guide is a great place to start.