Search
Close this search box.

< / >

APIs

15. Remove activity codes

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, 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.
  • If you want to delete multiple activity codes, you should use the following example structure of the request body to consume the API. Remember it must be in raw format.
    • {
      “type_code”: “cod_act1”,
      “cod_act”: [
      “100”,
      “200”,
      “300”
      ]
      }
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAMEDESCRIPTIONTYPE
type_codeActivity 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_actName or identification number of the activity codeString

Response

NAMEDESCRIPTIONTYPE
codeResponse codeint
errorErrorString
msgDescription of the responseString
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": "{{type_code}}",
    "cod_act": [
        "{{cod_act}}",
        "{{cod_act}}"
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$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