fbpx

< / >

APIs

15. Remove activity codes En

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=remove_cod_act

Description:

This API allows you to remove activity codes from external applications to make this process simpler and more agile.

Benefit:

Simplify the process of eliminating activity codes and optimize the processes of managing them.

how it works:

  • The consumption of this API is done by DELETE method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.

NAME DESCRIPTION TYPE
type_code Activity code group it belongs to. It can receive the value “cod_act1” to refer to activity code group #1 and “cod_act2” for activity code group #2. String
cod_act Name or identification number of the activity code String

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response String

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=remove_cod_act',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS =>'{
      "type_code": " ",
      "cod_act": " "
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": "201",
    "error": null,
    "msg": "Removed successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data