Categories

CRUD endpoints for a user's categories

Please note that in all urls & code samples you'll need to replace:username and :corporation with appropriate values

Get All Categories

GET /v2/organization/:corporation/staff/:username/category

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Url

Name	Type	Description
corporation	number	Corporation ID
username	string	Unique username

Response

200

 {
  data: [
    {
      id: 1,
      category_id: 1,
      category: "category name"
    }
  ],
  success: true
}

Code

Node

const accessToken = `<ACCESS TOKEN>`

fetch('https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category', {
    method: 'GET',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Authorization': `Bearer ${accessToken}`
    }
})
.then(response => response.json())
.then(json => {
    const { success, data } = json

    if (success) {
        const category = data
        console.log('category', category)
    }

})
.catch(error => console.error(error));

PHP

$accessToken = urlencode('<ACCESS TOKEN>');
$url = 'https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category';

$ch = curl_init($url);
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    array('Content-Type: application/x-www-form-urlencoded', 'Authorization: Bearer ' . $accessToken)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$json = json_decode($response);

if($json->success){
    var_dump($json->data);
}

curl_close($ch);

Curl

curl https://public-api.expertfile.com/v2/organi
zation/:corporation/staff/:username/category \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <ACCESS TOKEN>"

Get Individual Category

GET /v2/organization/:corporation/staff/:username/category/:id

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Url

Name	Type	Description
corporation	number	Corporation ID
username	string	Unique username
id	number	Category ID

Response

200

{
  data: [
    {
      id: 1,
      category_id: 1,
      category: "category name"
    }
  ],
  success: true
}

Code

Node

const accessToken = `<ACCESS CODE>`

fetch('https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id', {
    method: 'GET',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Authorization': `Bearer ${accessToken}`
    }
})
.then(response => response.json())
.then(json => {
    const { success, data } = json

    if (success) {
        const category = data
        console.log('category', category[0])
    }

})
.catch(error => console.error(error));

PHP

$accessToken = urlencode('<ACCESS TOKEN>');
$url = 'https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id';

$ch = curl_init($url);
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    array('Content-Type: application/x-www-form-urlencoded', 'Authorization: Bearer ' . $accessToken)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$json = json_decode($response);

if($json->success){
    var_dump($json->data);
}

curl_close($ch);

Curl

curl -X GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <ACCESS TOKEN>"     

Create Category

POST /v2/organization/:corporation/staff/:username/category

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Url

Name	Type	Description
corporation	number	Corporation ID
username	string	Unique username

Body

Name	Type	Description
name*	string	Category Name

Response

200

{ 
    data: { 
        id: 1
    }, 
    success: true 
}

Code

Node

const data = new URLSearchParams();
const accessToken = `<ACCESS TOKEN>`

data.append('name', 'Test');

fetch('https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Authorization': `Bearer ${accessToken}`
    },
    body: data
})
.then(response => response.json())
.then(json => {
    const { success, data, error } = json

    if (success) {
        const { id } = data
        console.log('New category id', id)
    }

})
.catch(error => console.error(error));

PHP

$accessToken = urlencode('<ACCESS TOKEN>');

$url = 'https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category';
$data = ['name' => 'Test'];

$ch = curl_init($url);
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    array('Content-Type: application/x-www-form-urlencoded', 'Authorization: Bearer ' . $accessToken)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

$response = curl_exec($ch);
$json = json_decode($response);

if($json->success){
    var_dump($json->data);
}

curl_close($ch);

Curl

curl -X POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <ACCESS TOKEN>" \
    -d '{"name":"Test"}'

Delete Category

DELETE/v2/organization/:corporation/staff/:username/category/:id

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Url

Name	Type	Description
corporation	number	Corporation ID
username	string	Unique username
id	number	Category ID

Response

200

{ 
    data: { 
        deleted: true, 
        id: 1
    }, 
    success: true 
}

Code

Node

const accessToken = `<ACCESS TOKEN>`

fetch('https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id', {
    method: 'DELETE',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Authorization': `Bearer ${accessToken}`
    }
})
.then(response => response.json())
.then(json => {
    const { success, data, error } = json

    if (success) {
        const { id } = data
        console.log('Deleted category id', id)
    }

})
.catch(error => console.error(error));

PHP

$accessToken = urlencode('<ACCESS TOKEN>');

$url = 'https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id';

$ch = curl_init($url);
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    array('Content-Type: application/x-www-form-urlencoded', 'Authorization: Bearer ' . $accessToken)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");

$response = curl_exec($ch);
$json = json_decode($response);

if($json->success){
    var_dump($json->data);
}

curl_close($ch);

Curl

curl -X DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <ACCESS TOKEN>"