Release a Client's Lock

Details:

This API Call allows you to release a "lock" to a specific client record.
the "lock" action is required in order to update data to the client's record.
The RELEASE function has to be initiated after updating data is over, otherwise the locked client couldn't be edited/updated via other Hyper Users!

API Function Call Name:

Release_Client_json

Function Details:

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

Function Input

you can release the client's record by posting the following identifying fields only:
Field Description
ApiToken Mandatory.
ClientNumber 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: 003 will be returned.
{
  "ResponseCode": "003",
  "ResponseMsgEng": "API function does not exists."
}


Error Code in case of No Previous Lock Found/Preformed:
without them an Error Code: 006 will be returned.
{
  "ResponseCode": "006",
  "ResponseMsgEng": "Technical Error: Client Session not found."
}


Successful Response:
{
  "ResponseCode": "000",
  "ResponseMsgEng": "Client Released and session is over"
}

Click Here to view all possible Response Codes list.