{"id":788,"date":"2023-06-30T10:40:14","date_gmt":"2023-06-30T10:40:14","guid":{"rendered":"https:\/\/doc.bim.fm\/index.php\/docs\/multi-api\/"},"modified":"2023-06-30T14:00:21","modified_gmt":"2023-06-30T14:00:21","slug":"api-2","status":"publish","type":"docs","link":"https:\/\/doc.bim.fm\/index.php\/docs\/api-2\/","title":{"rendered":"API"},"content":{"rendered":"\n

Introduction<\/h2>\n\n\n\n

API est l’abr\u00e9viation de Application Programming Interface (interface de programmation d’applications). En termes simples, les API sont un ensemble de fonctions et de proc\u00e9dures qui permettent de cr\u00e9er des applications qui acc\u00e8dent aux donn\u00e9es et aux caract\u00e9ristiques d’autres applications, services ou syst\u00e8mes d’exploitation.<\/p>\n\n\n\n

Dans notre cas, vous pouvez utiliser notre API facilement gr\u00e2ce \u00e0 notre paquetage nugget disponible pour l’application .NET.<\/p>\n\n\n\n

<\/p>\n\n\n\n

Authentification<\/a><\/h2>\n\n\n\n

Verrouiller le fichier<\/a><\/h2>\n\n\n\n

<\/p>\n\n\n\n

Informations utiles sur les classes<\/h2>\n\n\n\n

ResponseApi<\/h4>\n\n\n\n

Dans tous vos appels, le paquet Nugget vous enverra un objet ResponseApi<\/p>\n\n\n\n

La classe est d\u00e9finie comme suit :<\/p>\n\n\n\n

<\/p>\n\n\n\n

Attribut<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td><\/tr>
ErrorCode<\/td>string<\/td>Code d’erreur envoy\u00e9 par le serveur. Si votre demande contient une erreur, cet attribut sera instanci\u00e9. Il contiendra toujours un nombre avec un index de l’Enum ErrorCode en dessous de ce tableau.<\/td><\/tr>
Status<\/td>int<\/td>Code d’\u00e9tat http<\/td><\/tr>
Detail<\/td>List<\/td>Liste des messages d’erreur<\/td><\/tr>
Result<\/td>T (depends of the Rqs)<\/td>R\u00e9sultat du mod\u00e8le Dto<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

ErrorCode Enum<\/h4>\n\n\n\n
Key<\/strong><\/td>Value<\/strong><\/td>Description<\/strong><\/td><\/tr>
-2<\/td>BAD_REQUEST<\/td><\/td><\/tr>
-1<\/td>PARAMETERS_ERROR<\/td><\/td><\/tr>
0<\/td>PERSISTENCE_EXCEPTION<\/td><\/td><\/tr>
1<\/td>INSTANCE_NOT_FOUND<\/td><\/td><\/tr>
2<\/td>USER_NOT_CREATE_ON_IDENTITY_SERVER<\/td><\/td><\/tr>
3<\/td>INVALID_GUID<\/td><\/td><\/tr>
4<\/td>USER_NOT_REGISTER<\/td><\/td><\/tr>
5<\/td>INSTANCE_ALREADY_EXIST<\/td><\/td><\/tr>
6<\/td>PERMISSION_DENY<\/td><\/td><\/tr>
7<\/td>EXPECTED_MULTIPART_REQUEST<\/td><\/td><\/tr>
8<\/td>FORM_DATA_PRESENT<\/td><\/td><\/tr>
9<\/td>UPLOADED_FILE_IS_EMPTY<\/td><\/td><\/tr>
10<\/td>FORMAT_EXCEPTION<\/td><\/td><\/tr>
11<\/td>ELASTIC_SEARCH_ERROR<\/td><\/td><\/tr>
12<\/td>IFC_UPDATE<\/td><\/td><\/tr>
13<\/td>IFC_GET<\/td><\/td><\/tr>
14<\/td>STORAGE_NOT_CONNECTED<\/td><\/td><\/tr>
15<\/td>STORAGE_FAIL_CREATE<\/td><\/td><\/tr>
16<\/td>STORAGE_SWIFT_API_ERROR<\/td><\/td><\/tr>
17<\/td>STORAGE_FILE_NOT_FOUND<\/td><\/td><\/tr>
18<\/td>INVALID_FORMAT_DATE<\/td><\/td><\/tr>
19<\/td>DATABASE_SCHEMA_NOT_VALIDATED<\/td><\/td><\/tr>
20<\/td>NHSESSION_ALREADY_EXIST<\/td><\/td><\/tr>
21<\/td>FILE_NOT_LOCK<\/td><\/td><\/tr>
22<\/td>FILE_ALREADY_LOCK<\/td><\/td><\/tr>
23<\/td>FILE_LOCKED<\/td><\/td><\/tr>
24<\/td>LOCK_CONFLICT<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"featured_media":0,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"_links":{"self":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/788"}],"collection":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/comments?post=788"}],"version-history":[{"count":6,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/788\/revisions"}],"predecessor-version":[{"id":986,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/788\/revisions\/986"}],"next":[{"title":"Tableau de bord","link":"https:\/\/doc.bim.fm\/index.php\/docs\/tableau-de-bord\/","href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/294"}],"wp:attachment":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/media?parent=788"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/doc_tag?post=788"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}