Organization Service V4

Organization Service


Project maintained by npr Hosted on GitHub Pages — Theme by mattgraham

Back to API Documentation

POST Legacy Organizations

/v4/legacy/organizations

This endpoint requires authorization.

Body

This endpoint requires a JSON body consisting of an array of objects. Each object must contain the following attributes:

Attribute Data Type Description
orgId string the org ID of the legacy organization to associate with the service
serviceId string the service ID to associate the legacy organization to

Description

This endpoint is used to associate a set of Legacy Organizations to Services.

When run, this endpoint will loop through the provided array and, for each orgId, update the Legacy Organization data in the Organization Service so that it shows an association with the Service identified by serviceId. This data will be available via the GET Legacy Organization endpoint.

A successful retrieval will result in a 204 status.

Example Body

[
  {
    "orgId": "123",
    "serviceId": "s456"
  },
  {
    "orgId": "789",
    "serviceId": "c100"
  }
]