GET GetDocuments

Ce endpoint de l'API permet de récupérer la liste paginée des documents répondants aux critères choisis ainsi que les identifiants des blobs associés

La description complète est accessible sur notre swagger

Requête

Param	Type	Description	Exemple
`externalRef`	string/string	Source de données/id externe d'une personne La source de donnée peut être de la forme technique ou le nom de la source	`5a155052c2dcee2eccb26c99/refclient42` `salariés/refclient42`
`path`	string	Chemin vers le document dans le classeur Si externalRef est précisé, le path démarrera du dossier pointé par l'externalRef	`Salariés/Jean Dupont/Attestation d'honorabilité` Exemple avec external ref "refclient42" renseignée, je n’ai besoin de mettre que : `Attestation d'honorabilité`
`q`	string	nom partiel du document à chercher	Attest
`documentCompletenessStatuses`	MISSING \| OUTDATED \| TO_CHECK \| UP_TO_DATE \| NOT_SUITABLE	Statut de complétude (répétable) MISSING : Document manquant OUTDATED : Document à mettre à jour TO_CHECK : Document à vérifier UP_TO_DATE : Document à jour NOT_SUITABLE : Non renseigné	MISSING
`documentConformityStatuses`	MISSING \| CONFORMS \| NOT_CONFORMS \| PARTIAL_CONFORMS \| NOT_SUITABLE	Statut de conformité (Répétable MISSING: Document manquant CONFORMS : Document à conforme NOT_CONFORMS : Document non conforme PARTIAL_CONFORMS : Document conforme avec réserve NOT_SUITABLE: Non rensigné	CONFORMS
`currentPage`	integer	Page courante	1
`selectCompanyId`	integer	id de la société à utiliser (à définir si plusieurs sociétés disponibles)	`5a155052c2dcee2eccb26c99`

Réponse

Extrait de réponse sur la récupération d’attestation d’honorabilité manquants sur une société

JSON

{
    "results": [
        {
            "path": "5a155052c2dcee2eccb26c99",
            "completenessStatus": {
                "type":"TO_CHECK",
                "date": "2017-11-23T09:55:43.726Z",
                "forced": true
            },
            "conformityStatus": {
                "type":"TO_CHECK",
                "date": "2017-11-23T09:55:43.726Z",
                "forced": true,
                "comment": "commentaire",
            },
            "upToDateDate": "2017-11-22T10:24:18.019Z",
            "experitionDate": "2018-11-22T09:55:43.726Z",
            "blobIds": ["5a155052c2dcee2eccb26c99"]
        },
        {
            "path": "5a155052c2dcee2eccb26c99",
            "completenessStatus": {
                "type":"TO_CHECK",
                "date": "2017-11-23T09:55:43.726Z",
                "forced": true
            },
            "conformityStatus": {
                "type":"TO_CHECK",
                "date": "2017-11-23T09:55:43.726Z",
                "forced": true
            },
            "upToDateDate": "2017-11-22T10:24:18.019Z",
            "experitionDate": "2018-11-22T09:55:43.726Z",
            "blobIds": ["5a155052c2dcee2eccb26c99"],
            "statusComment": "Un commentaire"
        }
    ],
    "nbOfResults": 2,
    "pagination": {
        "currentPage": 2,
        "nbOfResultsPerPage": 25}
]