Gestion d’un groupe ad hoc

Les groupes ad hoc sont utiles lorsque vous souhaitez envoyer des documents à signer lorsque vous souhaitez qu’un groupe spécifique de destinataires soit affecté à un groupe spécifique, et que tout membre de ce groupe peut signer le document avec sa propre signature pour une seule transaction.

Pour activer les groupes ad hoc, veuillez contacter notre équipe d’assistance.

Ajout d’un groupe ad hoc

Les groupes ad hoc et leurs membres peuvent être mis à jour via les appels POST suivants :

• API/packages (dans le cadre de l’appel de création de transaction)

• api/packages/{packageId}/roles : Étant donné que cet appel permet de créer un seul destinataire à la fois, vous devrez d’abord ajouter les membres individuels en tant que signataires, puis ajouter le groupe ad hoc avec les associations de membres.

• api/packages/{packageId}/groups : Il s’agit d’un nouvel appel qui permet d’ajouter un groupe ad hoc et ses membres en un seul appel. Notez que dans le cadre de la bêta, cet appel ne dispose d’aucune fonctionnalité de restauration.

Bien qu’il s’agisse signerType d’une propriété facultative pour tous les signataires existants, elle doit être spécifiée pour le nouveau type de signataire Groupe ad hoc. Voir Role Types and Signer Types pour obtenir la liste complète des types de rôle et des types de signataire pris en charge dans le système.

Mise à jour d’un groupe ad hoc

Les groupes ad hoc et leurs membres peuvent être mis à jour via les appels PUT suivants :

• api/packages/{packageId}/roleId : Étant donné que cet appel permet de mettre à jour un seul destinataire à la fois, vous devrez mettre à jour les membres et le groupe ad hoc individuellement.

• api/packages/{packageId}/groups : Il s’agit d’un nouvel appel qui permet de mettre à jour un groupe ad hoc et ses membres en un seul appel.  

Il ne sera pas possible de mettre à jour les informations sur le groupe ad hoc ou les membres du groupe ad hoc lorsqu’une signature acceptée existe pour eux.  Une erreur sera générée.

A noter que lors de l’exécution d’un PUT sur le Role ou sur l’appel Groups, une logique de prétraitement est en place pour éviter la création de données partielles.  Les éléments suivants sont validés :

• La fonctionnalité Groupes ad hoc est activée pour le compte

• La transaction/le modèle n’est pas de type hébergé (en personne, iPen, RON, salle virtuelle)

• Le nom du groupe ad hoc est spécifié et est unique

• Le nombre de membres autorisés (10) n’est pas dépassé

Notes:

• Un nouveau type de signataire a AD_HOC_GROUP_SIGNER été introduit.  Ce type de signataire sera utilisé pour identifier le destinataire du groupe ad hoc.

• Un nouveau type de membre de groupe appelé AD_HOC_GROUP_MEMBER a été introduit. Ce type de membre sera utilisé pour identifier un destinataire qui n’est qu’un membre d’un groupe ad hoc et non un signataire individuel dans la transaction ou le modèle.

• Un nouveau type de membre de groupe appelé SIGNER a été introduit. Ce type de membre sera utilisé pour identifier un destinataire qui est à la fois membre d’un groupe ad hoc et signataire individuel dans la transaction ou le modèle. Ceci n’est pris en charge que via l’API pour la version bêta.

• Une fois que le groupe ad hoc et ses membres sont ajoutés en tant que rôles individuels, vous pouvez ensuite établir l’association entre eux via le modèle de signataire du groupe ad hoc à l’aide de leurs identifiants.

• Un seul type de membre peut être défini pour un destinataire donné. Si vous définissez différents types de membres pour un destinataire donné (par exemple, le type de membre « SIGNER » dans le groupe ad hoc1 et le type de membre « AD_HOC_GROUP_MEMBER » dans le groupe ad hoc 2), une erreur sera générée.

Bien qu’il s’agisse signerType d’une propriété facultative pour tous les signataires existants, elle doit être spécifiée pour le nouveau type de signataire Groupe ad hoc. Voir Role Types and Signer Types pour obtenir la liste complète des types de rôle et des types de signataire pris en charge dans le système.

REST API

Requête HTTP

POST /api/packages

En-têtes HTTP

Authorization: Basic api_key
Accept: application/json
Content-Type: application/json

Charge utile de la demande

 "roles": [
        {
            "type": "SIGNER", 
            "id": "member-role-1",
            "signers": [
                {
                    "email": "johndoe@gmail.com",
                    "firstName": "John",
                    "lastName": "Doe",
                    "title":"",
                    "company":""
                }
            ]
        },
        {
            "type": "SIGNER",
            "id": "member-role-2",
            "signers": [
                {
                    "email": "janedoe@gmail.com",
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "title":"",
                    "company":"" 
                }
            ]
        },
        {
            "type": "SIGNER",
            "id": "member-signer-role-3",
            "signers": [
                {
                    "email": "jessycollins@gmail.com",
                    "firstName": "Jessy",
                    "lastName": "Collins",
                    "title":"",
                    "company":"" 
                }
            ]
        },          {
            "type": "SIGNER",   
            "id": "group-role-1",
            "signers": [
                {
                    "firstName": "Borrowers",
                    "signerType": "AD_HOC_GROUP_SIGNER",
                    "group": {
                        "members": [
                            {
                                "userId": "member-role-1",
								"memberType": "AD_HOC_GROUP_MEMBER"
                            },
                            {
                                "userId": "member-role-2",
								"memberType": "AD_HOC_GROUP_MEMBER"
                            },
                            {
                                "userId": "member-signer-role-3",
								"memberType": "SIGNER"
                            }                         
                        ]
                    }
                }
            ]
        }
    ]

Charge utile de réponse

{

"id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="

}

Requête HTTP

POST /api/packages/{packageId}/groups

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Charge utile de la demande

 [
    {
        "type": "SIGNER",
        "id": "member-role-1",
        "signers": [
            {
                "firstName": "John",
                "lastName": "Doe",
			    "email": "johndoe@gmail.com",
                "company": "",
                "title": ""
            }
        ]        
    },
    {
         "type": "SIGNER",  
         "id": "member-role-2",
         "signers": [
            {
                "firstName": "Jane",
                "lastName": "Doe",
                "email": "janedoe@gmail.com",
                "company": "",
                "title": ""
            }
        ]
    },
    {
        "type": "SIGNER",
        "id": "group-role-1",
        "name": "Borrowers Role",
        "signers": [
            {
                "firstName": "Borrowers",
                "signerType": "AD_HOC_GROUP_SIGNER",
                "group": {
                    "members": [
                        {
                            "userId": "member-role-1",
                            "memberType": "AD_HOC_GROUP_MEMBER"
                        },
                        {
                            "userId": "member-role-2",
                            "memberType": "AD_HOC_GROUP_MEMBER"
                        }
                    ]
                }
            }
        ]
    }
]

Charge utile de réponse

 {

}

Appendice

Types de rôle et de signataire

Le tableau suivant présente les types de destinataires existants et nouveaux, ainsi que les rôles et les types de signataires qui leur sont associés. Les nouveaux articles sont marqués en gras.