Delete a Certification

Delete a Certification

DELETE https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}

This endpoint allows you to delete a certification.

Headers

Name	Type	Description
x-http-authorization*	String	API Key received from https://iafcertsearch.org/import-management/api-integration Example: x-http-authorization: <<API KEY>>
Content-Type*	String	application/json

200: OK Request successful.

{
  "data": 1
}

401: Unauthorized Happens when you use an invalid API Key.

{
    "error": true,
    "timestamp": number (Epoch time),
    "elapse": number,
    "errors": {
      "message": "Invalid Session token has been used.",
      "code": "invalid_session_token"
    }
}

404: Not Found Happens when the certification id does not exist in the IAF CertSearch database.

{
  "error": true,
  "timestamp": number (Epoch time),
  "elapse": number,
  "errors": {
    "message": "The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.",
    "code": "not_found"
  }
}

To view the response data example, click the right arrow at the right side of the response description.

You can also use https://api.sandbox.iafcertsearch.org/api/client/v2/ab/cert/{certification_id} to test it on the Sandbox server.

Take a look at how you might call this method:

cURL

curl --location -g --request DELETE 'https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}' \
--header 'Content-Type: application/json' \
--header 'x-http-authorization: <<API_KEY>>'

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = "application/json"
request["x-http-authorization"] = "<<API_KEY>>"

response = https.request(request)
puts response.read_body

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.iafcertsearch.org")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'x-http-authorization': '<<API_KEY>>'
}
conn.request("DELETE", "/api/client/v2/ab/cert/{certification_id}", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}',
  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_HTTPHEADER => array(
    'Content-Type: application/json',
    'x-http-authorization: <<API_KEY>>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}")
  .method("DELETE", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("x-http-authorization", "<<API_KEY>>")
  .build();
Response response = client.newCall(request).execute();

Node.js

var axios = require('axios');

var config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: 'https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}',
  headers: { 
    'Content-Type': 'application/json', 
    'x-http-authorization': '<<API_KEY>>'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}"
  method := "DELETE"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("x-http-authorization", "<<API_KEY>>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

C#

var client = new RestClient("https://api.iafcertsearch.org/api/client/v2/ab/cert/{certification_id}");
client.Timeout = -1;
var request = new RestRequest(Method.DELETE);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("x-http-authorization", "<<API_KEY>>");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.client);