HVOOrganizationTransactionBundle

Constraints

The HVOOrganizationTransactionBundle must consist of at least one entry with a HVOOrganization or at least one entry with a HVOOrganizationalUnit.

For all resources that are being created, the entry.fullUrl element must use a unique temporary UUID, which should also be used to reference to each other when needed. In the example below, Organization1 is referenced to in OrganizationalUnit1.partOf by the entry's fullUrl "urn:uuid:123-456-789". The UUID can have any sequence of characters or digits, as long as it is unique in the Bundle. The request.method element of all entries must be set to POST.

For all resources that are being updated, the entry.resource.id element must contain the existing resource's UUID. The request.method element of all entries must be set to PUT or PATCH. The only elements that can be updated using PATCH are name, period.start and period.end. All values must be entered if they exist.

Note that certain data of an organization is retrieved from official registries and can not be altered through the API. See handbok for where to turn to update this kind of information.

Some of these elements are profiled as mandatory, ie have a cardinality of 1..1, which should be interpreted as a certainty that they will be included in a read. These elements WILL NOT be updated in the backend if provided in a PUT/POST request. The elements to which this applies are listed down below:

• name
• alias
• contact.address
• legalForm
• period
• organizationActive

Operations

The URL of an operation of a Bundle does not contain the resource type, since the Bundle in this context is used as a transaction containing multiple resources. The invocation then consists only of the base address: POST [base]/

Note that the HTTP verb for the operation is POST even if only updates are being performed. Specifying the POST or PUT action is done per resource, on each entry.request.method.

Headers

Examples

Example 1. Create a HVOOrganization and a HVOOrganizationalUnit

Example 2. HVOOperationOutcome returned with errors

The example below shows how a HVOOperationOutcome might look like if any entries in the Bundle contains errors. Note that the issue.expression field is used to indicate which entry the issue belongs to, where Bundle.entry[0] references the first entry in the Bundle.