API

Print

Introduction

API stands for Application Programming Interface. 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.

In our case, you can use our API easily though our nugget package nugget available for .NET Application

Authentificate

Lock file

Usefull Class Information

ResponseApi

In all your calls, the Nugget package will send you an ResponseApi object.

The class is defined as follow :

AttributeTypeDescription
ErrorCodestringAn 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.
StatusintHttp status code
DetailListError message list
ResultT (depends of the Rqs)Dto model result

ErrorCode Enum

KeyValueDescription
-2BAD_REQUEST
-1PARAMETERS_ERROR
0PERSISTENCE_EXCEPTION
1INSTANCE_NOT_FOUND
2USER_NOT_CREATE_ON_IDENTITY_SERVER
3INVALID_GUID
4USER_NOT_REGISTER
5INSTANCE_ALREADY_EXIST
6PERMISSION_DENY
7EXPECTED_MULTIPART_REQUEST
8FORM_DATA_PRESENT
9UPLOADED_FILE_IS_EMPTY
10FORMAT_EXCEPTION
11ELASTIC_SEARCH_ERROR
12IFC_UPDATE
13IFC_GET
14STORAGE_NOT_CONNECTED
15STORAGE_FAIL_CREATE
16STORAGE_SWIFT_API_ERROR
17STORAGE_FILE_NOT_FOUND
18INVALID_FORMAT_DATE
19DATABASE_SCHEMA_NOT_VALIDATED
20NHSESSION_ALREADY_EXIST
21FILE_NOT_LOCK
22FILE_ALREADY_LOCK
23FILE_LOCKED
24LOCK_CONFLICT