Custom fields - Person, Groups and GroupMembers

[DumbergerL]

Suggestion from forum: https://forum.church.tools/topic/9358/churchtools-api-client-php/5?_=1685434052136

TODO:

• Wrap GroupMemberFields-API 7fe4e67
• Wrap DBFields-AP
• Display DB-Field Values (e.q. GroupInformation, Persons... ...)

[DumbergerL]

Custom fields in Group-Members:

Example data:

Retrieve Member-Fields configuration via /api/groups/9/memberfields:

[
    {
        "type": "person",
        "field": {
            "id": 3,
            "groupId": 9,
            "dbField": {
                "id": 54,
                "key": "nickname",
                "name": "nickname",
                "nameTranslated": "Spitzname",
                "column": "spitzname",
                "shorty": "",
                "fieldCategoryCode": "f_address",
                "fieldTypeCode": "text",
                "fieldTypeId": 1,
                "isActive": "1",
                "isNewPersonField": false,
                "lineEnding": "(%) ",
                "secLevel": 1,
                "length": 30,
                "sortKey": 3,
                "deleteOnArchive": false,
                "nullable": false,
                "hideInFrontend": false,
                "isBasicInfo": "0",
                "options": []
            },
            "sortKey": 0,
            "requiredInRegistrationForm": false
        }
    },
    {
        "type": "group",
        "field": {
            "id": 3,
            "groupId": 9,
            "fieldName": "vocal range",
            "note": "vocal range of person from key to key",
            "sortKey": 1,
            "fieldTypeId": 1,
            "fieldTypeCode": "text",
            "securityLevel": 1,
            "defaultValue": "",
            "options": [],
            "useInRegistrationForm": false,
            "requiredInRegistrationForm": false
        }
    }
]

Data:

• GroupMember - Model contains Attributes "fields" and "personFields"

[DumbergerL]

Custom fields in Groups

Create custom field

1. Stammdaten
2. DB-Felder
3. Create field with "DB-Feld-Typ" = Gruppe
4. Example identifier: 5pm_name

Retrieve custom group fields:

• retrieve with /api/groups/9
• in path "information.5pm_name"