Update Client's Extended record

Details:

This API Call allows you to update the a client's extended record details, existing in "hyp_Clients Record Extension" table.
For this API call you are required to pre-run the "Lock" function to the desired client record, and then run this call.
The update will occur in "hyp_Client Record Extension" table, which is an extension table that could contain Extra details about the "Locked" client record.

API Function Call Name:

Update_Client_Ext_json

Function Details:

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

Function Input:

The update will occur in "hyp_Client Record Extension" table, which is an extension table to the client's record.
To retrieve the entire list of fields approved for updating VIA this API Call - Post this function with the parameters: "ApiToken" & "json = help".


To update a Client's Extension record post the requested fields along with the mandatory fields:
ApiToken - Mandatory.

This function updates fields that where predetermined in "hype_Client Record Extension" table,
that means that those fields where given a "json Field Name" by Hyper system admin as shown in the example picture below.


* IMPORTANT:
After the update has been completed - Do Not forget to release the client's record VIA "Release_Client_json" Function.

Postman Example:


Response Code Examples:

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

Error Code in case of missing mandatory fields (ApiToken):
without them an Error Code: 003 will be returned.
{
  "ResponseCode": "003",
  "ResponseMsgEng": "API function does not exists."
}


Error Code in case of updating unauthorized fields:
The system will return an Error Code: 007.
{
  "ResponseCode": "007",
  "ResponseMsgEng": "Please fill up all the required fields."
}


Successful Update Response:
{
  "ResponseCode": "000",
  "ResponseMsgEng": "Success"
}

Click Here to view all possible Response Codes list.