{"id":992,"date":"2023-06-30T14:05:54","date_gmt":"2023-06-30T14:05:54","guid":{"rendered":"https:\/\/doc.bim.fm\/?post_type=docs&#038;p=992"},"modified":"2023-06-30T14:08:03","modified_gmt":"2023-06-30T14:08:03","slug":"api-3","status":"publish","type":"docs","link":"https:\/\/doc.bim.fm\/index.php\/en\/docs\/api-3\/","title":{"rendered":"API"},"content":{"rendered":"\n<h2>Introduction<\/h2>\n\n\n\n<p>API stands for&nbsp;<strong>Application Programming Interface<\/strong>. In basic terms, APIs are a set of functions and procedures that allow for the creation of applications that access data and features of other applications, services, or operating systems.<\/p>\n\n\n\n<p>In our case, you can use our API easily though our nugget package nugget available for .NET Application<\/p>\n\n\n\n<p><\/p>\n\n\n\n<h2><a href=\"https:\/\/doc.bim.fm\/index.php\/en\/docs\/api-3\/authentificate\/\" data-type=\"docs\">Authentificate<\/a><\/h2>\n\n\n\n<h2><a href=\"https:\/\/doc.bim.fm\/index.php\/en\/docs\/api-3\/lock-file\/\" data-type=\"docs\">Lock file<\/a><\/h2>\n\n\n\n<p><\/p>\n\n\n\n<h2>Usefull Class Information<\/h2>\n\n\n\n<h4>ResponseApi<\/h4>\n\n\n\n<p>In all your calls, the Nugget package will send you an ResponseApi object. <\/p>\n\n\n\n<p>The class is defined as follow :<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Attribute<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td>ErrorCode<\/td><td>string<\/td><td>An error code sent by the server. If there is an error in your request, this attribute will be instantiated. It will always contain a number with an index of the ErrorCode Enum below this table.<\/td><\/tr><tr><td>Status<\/td><td>int<\/td><td>Http status code<\/td><\/tr><tr><td>Detail<\/td><td>List<\/td><td>Error message list<\/td><\/tr><tr><td>Result<\/td><td>T (depends of the Rqs)<\/td><td>Dto model result<\/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\/992"}],"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=992"}],"version-history":[{"count":3,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/992\/revisions"}],"predecessor-version":[{"id":1000,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/992\/revisions\/1000"}],"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=992"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/doc_tag?post=992"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}