Connect to a client

Details:

This API Call allows you to connect and "lock" a specific client record.
the "lock" action is required in order to update data to the client's record.

API Function Call Name:

Connect_to_Client_Json

Function Details:

* Method = Post, Json
* Parameters Location: Body -> Form-Data
* Hyper Tables Involved: "hyp_Clients"

Function Input

you can connect and "Lock" the client's record by posting the following identifying fields only:
Field Description
ApiToken Mandatory
ClientNumber Mandatory - Hyper's internal client Key. You can retrieve it by searching for it VIA "Does_Client_Exist_Json" API call.

Postman Example:

Response Code Examples:

The response code hereby was copied from the "postman" Application.

Error Code in case of missing mandatory fields:
without them an Error Code: 007 will be returned.
{
  "ResponseCode": "007",
  "ResponseMsgEng": "Please fill up all the required fields."
}


Error Code in case the client record is locked by another user than the API:
In this case you'll have to postpone the connection to a later time.
{
  "ResponseCode": "012",
  "ResponseMsgEng": "This entity is already locked by another user."
}


Error Code in case of lock attempt when another client record is already locked by the API:
In this case no login is required. you can continue with the requested update API Calls.
{
  "ResponseCode": "010",
  "ResponseMsgEng": "User is already connected on this session (Logged in)."
}


Successful Response:
{
  "ResponseCode": "000",
  "ResponseMsgEng": "Client is Locked (for you) and loaded"
}

Click Here to view all possible Response Codes list.