Ressource: documents-static

Permet de récupérer les derniers documents depuis des url statiques

Généralités
  • Un document est associé à une part.
  • Un document est identifié par un idDocument

Télécharger un document

Télécharger un document
http://services.opcvm360.com/api-v1/documents-static/f1e6a011709dd9943eabbdb61866a87ef12678f0196c3a67a5892370bc358ba8f23c1d7b397a660b32b8a9bc9d3bbeed

Lister les documents

Lister les documents:

Lister tous les derniers documents disponibles pour vos part
Tester
http://services.opcvm360.com/api-v1/documents-static
Retourne tous les derniers documents disponibles.

Lister les documents à l'aide de critères de recherche:

Par défaut tous les documents disponibles pour une part sont retorunés

Vous pouvez filtrer ces résultats à l'aide des paramètres suivants

  • types pour filtrer les documents par types
  • languages pour filtrer les documents par langues
  • countries pour filtrer les documents par pays
  • fundshares pour filtrer les documents par parts
Récupérer les documents associés à une part à partir de son identifiant idFundShare
Tester
http://services.opcvm360.com/api-v1/documents-static?fundshares=1
Retourne les derniers documents associés à la part dont l'identifiant idFundShare est 1
Récupérer tous les documents distribués en France et en Français
Tester
http://services.opcvm360.com/api-v1/documents-static?countries=FR&languages=FR

Récupérer uniquement les documents mis à jours

Cette solution consiste à demander à l'API de retourner uniquement les documents qui ont été ajoutées ou modifiées dans notre base de données depuis votre dernière requête du même type. Vous êtes donc sûr de ne rater aucune mise à jour sans pour autant reparcourir la liste complète des documents. Pour cela utilisez le paramètre upFromDate=2013-11-22 pour donner la date de votre dernière requête de ce type.

  • upFromTime=10:05:00 pour préciser l'heure de début
  • upToDate=2013-11-23 pour préciser une date de fin
  • upToTime=10:05:00 pour préciser l'heure de fin

Exemple d'utilisation:

Récupérer les documents de toutes les parts mis à jour depuis le 01/02/2016 à 10:05:00
Tester
http://services.opcvm360.com/api-v1/documents-static?upFromDate=2016-02-01&upFromTime=10:05:00

Constantes

Certaines informations textuelles sont retournées sous forme de constantes, les tableaux ci-dessous vous permettent de faire la liaison entre constante et libellé. Il est donc aisé de redéfinir votre propre wording, de plus les modifications de notre côté n'impactent pas l'API.

Constantes pour le champ: idDocumentType

Constante Libellé
7 DICI
4 Prospectus complet
11 Fiche de présentation
5 Reporting annuel
2 Reporting semestriel
1 Reporting mensuel

Liste des informations disponibles pour la ressource

Déjà client ? Connectez-vous pour n'afficher que les données disponibles avec vos accès.

Nom dans l'API Description Type
idFundShare Identifiant interne de la part. Int
isin Code isin de la part. String
fundShareName Nom de la part. String
idDocument Identifiant interne du document. Int
libelle Libelle du document. String
idDocumentType Identifiant interne du type de document (constante). Int
type Type du document. String
lang Langue du document. String ISO2
country Pays du document. String ISO2
date Date du document. Date => YYYY-MM-DD
uploadDate Date d'insertion du document. Date => YYYY-MM-DD hh:mm:ss
link