Guide de migration

Catégorie : Core
Domaine : SystemInfo
Service : DossierReadAccess
Méthode : GetDossierForUser

Contrat de la V1

Verbe : GET
URL : https://cegid-expert-webapi-core.cegid.com/SystemInfo/DossierReadAccessWebService/GetDossierForUser
Paramètres : QUERY
Le contrat de la V1 impose la saisie d'un numéro de dossier via le paramètre noDossieret d'un identifiant d'utilisateur via le paramètre userId.
Réponse :
Exemple pour le dossier 001529 et l'utilisateur 263 :

{
    "noDossier": "001529",
    "description": "001529",
    "typeDossier": "PRO",
    "dossierRight": {
        "globalPassword": "",
        "isGlobalPassword": "X"
    },
    "dossierState": {
        "lock": "ENL",
        "missing": "-",
        "disable": "-"
    },
    "dossierGroup": [
        {
            "confidentialityGroup": "GR2"
        }
    ],
    "dossierPerson": {
        "personCode": 0,
        "personId": "FDE390D3-9CA5-4968-8E3E-B02500FC8713"
    }
}

Contrat de la V2

Verbe : POST
URL : https://api.cegid.com/cpa-expert-coreSystemInfo/DossierConsultationWebService/ViewDossiersUsingFilter
Paramètres : BODY
Le contrat de la V2 impose la pagination.
Pour obtenir la même donnée en V2, il est possible de renseigner un code utilisateur et d’ajouter un filtre sur le bon numéro de propriété.

Les numéros des propriétés sont affichés dans l’APIM :

Renseigner le même code utilisateur.
Filtrer sur la propriété 1 pour le code dossier avec l’opérateur de comparaison « Egal » (1) et la bonne valeur.

{
    "page": {
        "pageIndex": 1,
        "pageSize": 1
    },
    "userId" : "263",
    "filters": [{
        "Property": 1,
        "ConstantValue": "001529",
        "ComparisonOperateur": 1,
        "Inversion": false,
        "LogicOperator": 1
    }]
}

Réponse :
Le retour renvoie plus d’informations dans la V2.
Elles sont également organisées différemment.
Mais les informations disponibles dans la V1 le sont toujours dans la V2.

{
    "page": {
        "pageCount": 1
    },
    "dossierCollection": [
        {
            "id": "001529",
            "description": "001529",
            "typeId": 1,
            "typeCode": "PRO",
            "isAccountingFirm": false,
            "lastEntryModification": "2016-10-24T17:23:06",
            "legalInformation": {
                "id": "fde390d3-9ca5-4968-8e3e-b02500fc8713",
                "legalStatus": 1,
                "legalForm": "",
                "siren": "",
                "nic": "",
                "naf": "",
                "codeInsee": ""
            },
            "right": {
                "isGlobalPassword": true
            },
            "applicationProtectCollection": [],
            "state": {
                "lockId": 1,
                "lockCode": "ENL",
                "lockDescription": "en ligne",
                "disable": false,
                "missing": false
            },
            "confidentialityGroupCollection": [
                {
                    "name": "GR2"
                }
            ]
        }
    ]
}

Note

Le mot de passe n'est pas retourné s'il n'est pas défini.
S'il est défini, il sera retourné hashé via la propriété hashedGlobalPassword.

Important

La propriété PersonCode de la V1 n’est pas disponible dans la V2 car cette information n'est pas utilisée dans Cegid Expert.