API stands for\u00a0Application 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 In our case, you can use our API easily though our nugget package nugget available for .NET Application<\/p>\n\n\n\n <\/p>\n\n\n\n <\/p>\n\n\n\n In all your calls, the Nugget package will send you an ResponseApi object. <\/p>\n\n\n\n The class is defined as follow :<\/p>\n\n\n\nAuthentificate<\/a><\/h2>\n\n\n\n
Lock file<\/a><\/h2>\n\n\n\n
Usefull Class Information<\/h2>\n\n\n\n
ResponseApi<\/h4>\n\n\n\n
Attribute<\/strong><\/td> Type<\/strong><\/td> Description<\/strong><\/td><\/tr> ErrorCode<\/td> string<\/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> Status<\/td> int<\/td> Http status code<\/td><\/tr> Detail<\/td> List<\/td> Error message list<\/td><\/tr> Result<\/td> T (depends of the Rqs)<\/td> Dto model result<\/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":4,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"_links":{"self":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/569"}],"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=569"}],"version-history":[{"count":3,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/569\/revisions"}],"predecessor-version":[{"id":678,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/569\/revisions\/678"}],"prev":[{"title":"Support","link":"https:\/\/doc.bim.fm\/index.php\/docs\/support\/","href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/docs\/544"}],"wp:attachment":[{"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/media?parent=569"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/doc.bim.fm\/index.php\/wp-json\/wp\/v2\/doc_tag?post=569"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}