POST/transactional-api/create-content-package

Create Content Package

Creates a new content package for distributing resources to organisations.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/create-content-package' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "name": "string",
    "availability": "all_healthcare_organisations",
    "description": "string",
    "availableToTenants": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "availableToOdsCodes": "string"
  }'

Body parameters

Field	Type	Required	Description
name	string	Yes	Package name.
availability	enum	Yes	Distribution scope. Use specific_organisations to restrict to a list of tenants. One of: all_healthcare_organisations, specific_organisations.
description	string (nullable)	No	Optional description of the package.
availableToTenants	array<string<uuid>> (nullable)	No	Tenant IDs to distribute to. Required when availability is specific_organisations.
availableToOdsCodes	string (nullable)	No	Comma-separated ODS codes to distribute to. At least one of availableToTenants or availableToOdsCodes is required when availability is specific_organisations.

Responses

201 Created.

{
  "id": "00000000-0000-0000-0000-000000000000"
}

400 Invalid request.

3 possible code values

Code	Description	When
missing-required-field	fieldName is required	a required field is absent
invalid-operation	Human-readable reason.	business rule violation
invalid-field	fieldName must be a valid UUID	a UUID field is not a valid UUID

{
  "errors": [
    {
      "code": "missing-required-field",
      "description": "fieldName is required"
    }
  ]
}