Update Client Details
Details:
This API Call allows you to update details to the current locked client,that means, that you are required to pre-run the "Lock" function to the desired client record only!
API Function Call Name:
Update_Client_jsonFunction Details:
* Method = Post, Json* Parameters Location: Body -> Form-Data
* Hyper Tables Involved: "hyp_Clients"
Function Input:
This API call review and update all the fields in the client's record from "hyp_Clients" table.To retrieve the entire list of fields approved for updating VIA this API Call - Post this function with the parameters: "ApiToken" & "json = help" as shown.
To update a Client's records post the requested fields along with the mandatory fields:
ApiToken - Mandatory.
This function allow updating all the permitted native fields in "hype_Clients" table.
But in order to update the client's "Spare Fields", Hyper's system admin has to set the "json Field Name" value as shown in the example picture below,
only then those "Spare Fields" will be available for this API call.
Postman Example:
* IMPORTANT:
After the update has been completed - Do Not forget to release the client's record VIA "Release_Client_json" Function.
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."
}
"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."
}
"ResponseCode": "007",
"ResponseMsgEng": "Please fill up all the required fields."
}
Successful Update Response:
{
"ResponseCode": "000",
"ResponseMsgEng": "Success"
}
"ResponseCode": "000",
"ResponseMsgEng": "Success"
}
Click Here to view all possible Response Codes list.