Skip to main content
API docs by Redocly

MilMove Admin API (1.0.0)

Download OpenAPI specification:Download

E-mail: milmove-developers@caci.com License: MIT

The Admin API is a RESTful API that enables the Admin application for MilMove.

All endpoints are located under /admin/v1.

Admin users

Information about Admin UI users

https://transcom.github.io/mymove-docs/docs/api

List Admin Users

This endpoint returns a list of Admin Users. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
Array of strings
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Admin User

This endpoint creates an Admin User record and returns the created record in the 201 response. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

Request Body schema: application/json

Admin User information

email
string (Email)
firstName
string (First Name)
lastName
string (Last Name)
organizationId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "email": "user@userdomain.com",
  • "firstName": "string",
  • "lastName": "string",
  • "organizationId": "c56a4180-65aa-42ec-a945-5fd21dec0538"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetch a specific Admin User

This endpoint returns a single Admin User by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
adminUserId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Updates an Admin User

This endpoint updates a single Admin User by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
adminUserId
required
string <uuid>
Request Body schema: application/json

Admin User information

firstName
string or null (First Name)
lastName
string or null (Last Name)
active
boolean or null

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Client certificates

Information about Client Certificates

https://transcom.github.io/mymove-docs/docs/api

List client certificates

This endpoint returns a list of Client Certificates. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a client cert

This endpoint creates a Client Certificate record and returns the created record in the 201 response. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

Request Body schema: application/json

client cert information

email
required
string
sha256Digest
required
string
subject
required
string
allowOrdersAPI
boolean
allowAirForceOrdersRead
boolean
allowAirForceOrdersWrite
boolean
allowArmyOrdersRead
boolean
allowArmyOrdersWrite
boolean
allowCoastGuardOrdersRead
boolean
allowCoastGuardOrdersWrite
boolean
allowMarineCorpsOrdersRead
boolean
allowMarineCorpsOrdersWrite
boolean
allowNavyOrdersRead
boolean
allowNavyOrdersWrite
boolean
allowPrime
boolean
allowPPTAS
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allowDpsAuthAPI": true,
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

Get a client certificate

This endpoint returns a single Client Certificate by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
clientCertificateId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allowDpsAuthAPI": true,
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

Updates a client certificate

This endpoint updates a single Client Certificate by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
clientCertificateId
required
string <uuid>
Request Body schema: application/json

client cert information

sha256Digest
string
subject
string
allowDpsAuthAPI
boolean or null
allowOrdersAPI
boolean or null
allowAirForceOrdersRead
boolean or null
allowAirForceOrdersWrite
boolean or null
allowArmyOrdersRead
boolean or null
allowArmyOrdersWrite
boolean or null
allowCoastGuardOrdersRead
boolean or null
allowCoastGuardOrdersWrite
boolean or null
allowMarineCorpsOrdersRead
boolean or null
allowMarineCorpsOrdersWrite
boolean or null
allowNavyOrdersRead
boolean or null
allowNavyOrdersWrite
boolean or null
allowPrime
boolean or null
allowPPTAS
boolean or null

Responses

Request samples

Content type
application/json
{
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "allowDpsAuthAPI": true,
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allowDpsAuthAPI": true,
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

removes a client certificate

This endpoint removes a single Client Certificate by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
clientCertificateId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "sha256Digest": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
  • "subject": "CN=example-user,OU=DoD+OU=PKI+OU=CONTRACTOR,O=U.S. Government,C=US",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allowDpsAuthAPI": true,
  • "allowOrdersAPI": true,
  • "allowAirForceOrdersRead": true,
  • "allowAirForceOrdersWrite": true,
  • "allowArmyOrdersRead": true,
  • "allowArmyOrdersWrite": true,
  • "allowCoastGuardOrdersRead": true,
  • "allowCoastGuardOrdersWrite": true,
  • "allowMarineCorpsOrdersRead": true,
  • "allowMarineCorpsOrdersWrite": true,
  • "allowNavyOrdersRead": true,
  • "allowNavyOrdersWrite": true,
  • "allowPrime": true,
  • "allowPPTAS": true
}

Electronic orders

Information about electronic orders

https://transcom.github.io/mymove-docs/docs/api

List Electronic Orders

This endpoint returns a list of Electronic Orders. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
Array of strings
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total counts for the orders stored in MilMove

This endpoint returns a list of record counts for Electronic Orders. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
Array of strings
andFilter
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Moves

This endpoint returns a list of Moves. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get information about a Move

This endpoint returns a single Move by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
moveID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "serviceMember": {
    },
  • "locator": "12432",
  • "status": "DRAFT",
  • "show": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Toggle Move visibility

This endpoint updates a single Move by ID. This allows the Admin User to change the show field on the selected field to either True or False. A "shown" Move will appear to all users as normal, a "hidden" Move will not be returned or editable using any other endpoint (besides those in the Support API), and thus effectively deactivated. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
moveID
required
string <uuid>
Request Body schema: application/json

Move information

show
required
boolean

Responses

Request samples

Content type
application/json
{
  • "show": true
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "serviceMember": {
    },
  • "locator": "12432",
  • "status": "DRAFT",
  • "show": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Notifications

Information about notifications

https://transcom.github.io/mymove-docs/docs/api

List Notifications

This endpoint returns a list of Notifications that have been sent to Service Members. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transportation offices

Information about transportation offices

https://transcom.github.io/mymove-docs/docs/api

List Transportation Offices

This endpoint returns a list of Transportation Offices. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Office users

Information about office users

https://transcom.github.io/mymove-docs/docs/api

List of Office Users

This endpoint returns a list of Office Users. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Office User

This endpoint creates an Office User record and returns the created record in the 201 response. If there are issues with the Office User information provided a 422 response will occur with information about invalid fields and additional details. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

Request Body schema: application/json

Office User information

email
string (Email)
firstName
string (First Name)
middleInitials
string or null (Middle Initials)
lastName
string (Last Name)
telephone
string <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
transportationOfficeId
string <uuid>
Array of objects (OfficeUserRole)
Array of objects or null (OfficeUserPrivilege)

Responses

Request samples

Content type
application/json
{
  • "email": "user@userdomain.com",
  • "firstName": "string",
  • "middleInitials": "L.",
  • "lastName": "string",
  • "telephone": "212-555-5555",
  • "transportationOfficeId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "roles": [
    ],
  • "privileges": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "privileges": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get an Office User

This endpoint returns a single Office User by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
officeUserId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "privileges": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Updates an Office User

This endpoint updates a single Office User by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
officeUserId
required
string <uuid>
Request Body schema: application/json

Office User information

firstName
string or null (First Name)
middleInitials
string or null (Middle Initials)
lastName
string or null (Last Name)
telephone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
active
boolean or null
Array of objects (OfficeUserRole)
transportationOfficeId
string <uuid>
Array of objects (OfficeUserPrivilege)

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "middleInitials": "Q.",
  • "lastName": "string",
  • "telephone": "212-555-5555",
  • "active": true,
  • "roles": [
    ],
  • "transportationOfficeId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "privileges": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "privileges": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Organizations

Information about organizations

https://transcom.github.io/mymove-docs/docs/api

List Organizations

This endpoint returns a list of Organizations. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
Array of strings
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Uploads

Information about uploads

https://transcom.github.io/mymove-docs/docs/api

Get information about an Upload

This endpoint returns a single Upload by ID containing the given Upload and information about the Uploader and Move. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
uploadId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "moveLocator": "12432",
  • "upload": {
    },
  • "serviceMemberId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "serviceMemberFirstName": "string",
  • "serviceMemberLastName": "string",
  • "serviceMemberPhone": "string",
  • "serviceMemberEmail": "string",
  • "officeUserId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "officeUserFirstName": "string",
  • "officeUserLastName": "string",
  • "officeUserPhone": "string",
  • "officeUserEmail": "string"
}

Requested Office Users

Information about requested office users

https://transcom.github.io/mymove-docs/docs/api

List Users

This endpoint returns a list of Users. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get information about a User

This endpoint returns a single User by ID. This also returns the User's sessions as well. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "oktaEmail": "string",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "currentAdminSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w",
  • "currentMilSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w",
  • "currentOfficeSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w"
}

Update a User's session or active status

This endpoint updates a single User by ID. This can be used by the Admin User to update the User's session or the User's active status. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
userId
required
string <uuid>
Request Body schema: application/json

User information

revokeAdminSession
boolean or null
revokeOfficeSession
boolean or null
revokeMilSession
boolean or null
active
boolean or null

Responses

Request samples

Content type
application/json
{
  • "revokeAdminSession": true,
  • "revokeOfficeSession": true,
  • "revokeMilSession": true,
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "oktaEmail": "string",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "currentAdminSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w",
  • "currentMilSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w",
  • "currentOfficeSessionId": "WiPgsPj-jPySR1d0dpmvIZ-HvZqemjmaQWxGQ6B8K_w"
}

Webhook subscriptions

Information about Webhook subscriptions

https://transcom.github.io/mymove-docs/docs/api

Lists Webhook Subscriptions

This endpoint returns a list of Webhook Subscriptions. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Webhook Subscription

This endpoint creates a Webhook Subscription and returns the created record in the 201 response. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

Request Body schema: application/json

Webhook subscription information

subscriberId
required
string <uuid>
status
required
string or null (Webhook subscription status)
Enum: "ACTIVE" "FAILING" "DISABLED"
eventKey
required
string

A string used to represent which events this subscriber expects to be notified about. Corresponds to the possible event_key values in webhook_notifications.

callbackUrl
required
string

The URL to which the notifications for this subscription will be pushed to.

Responses

Request samples

Content type
application/json
{
  • "subscriberId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "status": "ACTIVE",
  • "eventKey": "string",
  • "callbackUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "subscriberId": "d494f114-05a2-4b39-840c-3d33243b7e29",
  • "status": "ACTIVE",
  • "callbackUrl": "string",
  • "severity": 0,
  • "eventKey": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string"
}

Get information about a Webhook Subscription

This endpoint returns a single Webhook Subscription by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
webhookSubscriptionId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "subscriberId": "d494f114-05a2-4b39-840c-3d33243b7e29",
  • "status": "ACTIVE",
  • "callbackUrl": "string",
  • "severity": 0,
  • "eventKey": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string"
}

Update a Webhook Subscription

This endpoint updates a single Webhook Subscription by ID. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

path Parameters
webhookSubscriptionId
required
string <uuid>
header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json

Webhook Subscription information

subscriberId
string or null <uuid>

Unique identifier for the subscriber

status
string or null (Webhook subscription status)
Enum: "ACTIVE" "FAILING" "DISABLED"
callbackUrl
string or null

The URL to which the notifications for this subscription will be pushed to.

severity
integer or null >= 0
eventKey
string or null

A string used to represent which events this subscriber expects to be notified about. Corresponds to the possible event_key values in webhook_notifications.

Responses

Request samples

Content type
application/json
{
  • "subscriberId": "d494f114-05a2-4b39-840c-3d33243b7e29",
  • "status": "ACTIVE",
  • "callbackUrl": "string",
  • "severity": 0,
  • "eventKey": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "subscriberId": "d494f114-05a2-4b39-840c-3d33243b7e29",
  • "status": "ACTIVE",
  • "callbackUrl": "string",
  • "severity": 0,
  • "eventKey": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string"
}

Requested office users

List of Office Users Requesting Accounts

This endpoint returns a list of Office Users. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

query Parameters
filter
string
page
integer
perPage
integer
sort
string
order
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Requested Office User

Retrieving a single office user in any status. This endpoint is used in the Admin UI that will allow the admin user to view the user's relevant data.

path Parameters
officeUserId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "privileges": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a Requested Office User

Updates a requested office user to include profile data and status. This will be used in the Admin UI for approving/rejecting/updating a user.

path Parameters
officeUserId
required
string <uuid>
Request Body schema: application/json
firstName
string or null (First Name)
middleInitials
string or null (Middle Initials)
lastName
string or null (Last Name)
email
string
telephone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
Array of objects (OfficeUserRole)
transportationOfficeId
string or null <uuid>
edipi
string
otherUniqueId
string
rejectionReason
string
status
string
Enum: "APPROVED" "REJECTED"

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "middleInitials": "Q.",
  • "lastName": "string",
  • "email": "user@userdomain.com",
  • "telephone": "212-555-5555",
  • "roles": [
    ],
  • "transportationOfficeId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "privileges": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}