Centres Configuration

A centre is the default label for a subdivision of a branch, which is the default label for an organization subdivision. A centre can be considered a sub-branch. Each branch can have multiple centres assigned to it.

If you wish, you may change the centre label. For more information, see Labels. For more information about managing your organization’s centres, see Branches and Centres. For the rest of this article we will use the terminology centre.

With Configuration as Code (CasC), you may batch configure your centre configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.

The scope of CasC for centres is limited to centres with references towards the linked objects. However, the configuration of linked objects will not be included, and they must be reconfigured separately.

Dependencies

The centres configuration has two direct dependencies:

• The branch to which the centre is assigned.
• The custom field definitions for which you can enter custom field values. Based on the custom field definition type, there may be several addition indirect dependencies, such as clients, groups, and users.

API operations

CasC for centres supports two operations.

Requests

For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.

The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.

GET configuration

curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/centres.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

PUT configuration

curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/centres.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @centres.yaml

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

@centres.yaml represents the absolute path of the file on your device.

Use “--data-raw” if you want to specify the configuration inline.

Example configuration

centres:
  - id: "DT1"
    name: "Down Town"
    assignedBranchId: "B1"
    state: "ACTIVE"
    meetingDay: "FRIDAY"
    notes: "All clients and officers gather in the market"
    address:
      line1: "line1"
      line2: "line2"
      city: "City"
      region: "Region"
      postcode: "789456"
      country: "Country"
  - id: "MP1"
    name: "Market Place"
    assignedBranchId: "B1"
    state: "ACTIVE"
    meetingDay: "FRIDAY"
    notes: "All clients and officers gather in the market"
    address:
      line1: "line1"
      line2: "line2"
      city: "City"
      region: "Region"
      postcode: "789456"
      country: "Country"
    customFieldValueSets:
      - id: "_grouped_set_id"
        groupedCustomFieldValues:
          - index: 1
            customFieldValues:
              - customFieldId: "_cf_id_1"
                value: "value_group_1_1"
              - customFieldId: "_cf_id_2"
                value: "value_group_1_2"
              - customFieldId: "_cf_id_3"
                value: "value_group_1_3"
          - index: 2
            customFieldValues:
              - customFieldId: "_cf_id_1a"
                value: "value_group_2_1a"
              - customFieldId: "_cf_id_2a"
                value: "value_group_2_2a"
              - customFieldId: "_cf_id_3a"
                value: "value_group_2_3a"
              - customFieldId: "_cf_id_3b"
                value: "client_id"
      - id: "_non_grouped_set_id"
        standardCustomFieldValues:
          - customFieldId: "_cf_non_grouped_1"
            value: "value_non_grouped_1"
          - customFieldId: "_cf_non_grouped_2"
            value: "value_non_grouped_2"
          - customFieldId: "_cf_non_grouped_3"
            value: "value_non_grouped_3"

General attributes

address

Every centre has one address associated to it with the following fields:

customFieldsValueSets

Every centre can have a list of custom field sets with their associated custom field values. Custom field sets can either be GROUPED or SINGLE.

The grouped custom field sets field is represented by an array of array of values. The single custom field sets field is represented by an array of values.

Replies

Validations

The Mambu API runs validation to verify the configuration request conforms to YAML syntax and the template for custom field definitions:

• References must be properly mapped and exist in the target system.
• Custom field definitions and custom field values must be accurate, including dependent custom field definitions.

Minimum requirements show the line with the syntax error. Configuration values may be provided in any order.

Basic fields validations

Custom field sets and custom field definition validations

Custom field value validation

The validations for the custom field values are based on the custom field definition type:

Warnings

Existing centres that are not included in configuration updates are deleted, unless the centre is assigned to a client or it has documents attached, in which case it cannot be deleted. Instead, it will be deactivated. When this occurs, the API returns a list of warning messages letting the user know which centres have been deleted and which centres were deactivated instead.

If you successfully delete a centre, you will receive the following warning message: "Centre [ id = CENTRE_ID] has been deleted."

If you try to delete a centre that is assigned to a client or that has documents attached, you will receive the following warning message: "Centre [id = CENTRE_ID] could not be deleted and was deactivated."