Skip to main content

Centreconfiguration

Model representation of the configuration for a centre.

address object

Represents an address.

citystring

The city for this address.

countrystring

The country that is part of the address.

line1string

The first line of the address.

line2string

The second line of the address.

postcodestring

The post code that is part of the address.

regionstring

The region that is part of the address.

assignedBranchIdstring

The ID of the branch this centre was assigned to.

customFieldValueSets object[]

Custom fields value sets of the centre.

  • Array [
    • groupedCustomFieldValues object[]

    Custom field values for group type sets. Ordered by the group index that must start from 0.

  • Array [
    • customFieldValues object[]required

    Custom field values of the group.

  • Array [
    • customFieldIdstringrequired

    User-defined ID, globally unique.

    valuestringrequired

    Custom field value

  • ]
    • indexinteger<int32>required

    Index representing the id of custom field values in a set.

  • ]
    • idstringrequired

    User-defined set ID, globally unique.

    standardCustomFieldValues object[]

    Custom field values for standard type sets. Ordered by custom field id.

  • Array [
    • customFieldIdstringrequired

    User-defined ID, globally unique.

    valuestringrequired

    Custom field value

  • ]
  • ]
    • idstringrequired

    User-defined ID, globally unique.

    meetingDaystring

    Enumeration for calendar days of week.

    Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

    namestringrequired

    Name of the centre.

    notesstring

    Notes of the centre.

    statestringrequired

    Model representation of the state of a centre.

    Possible values: [ACTIVE, INACTIVE]

    Centreconfiguration
    {
      "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postcode": "string",
        "region": "string"
      },
      "assignedBranchId": "string",
      "customFieldValueSets": [
        {
          "groupedCustomFieldValues": [
            {
              "customFieldValues": [
                {
                  "customFieldId": "string",
                  "value": "string"
                }
              ],
              "index": 0
            }
          ],
          "id": "string",
          "standardCustomFieldValues": [
            {
              "customFieldId": "string",
              "value": "string"
            }
          ]
        }
      ],
      "id": "string",
      "meetingDay": "MONDAY",
      "name": "string",
      "notes": "string",
      "state": "ACTIVE"
    }