Job Categories

Job Category Instance

Represents a single job category instance.

There are two types of job categories:

• System job categories are default job categories that are available to all companies.
• Custom job categories are company specific job categories.

URI

https://app.jobcast.net/api/v1.0/jobcategories/{id}

Properties

Property	Type	Description
id	Int32	Unique identifier of the job category.
name	String (max 50)	Human readable name for the job category.
company	Object or null	Value will be null for a system job category and an object with the following property for a custom job category.
	Property Type Description id Int32 Unique identifier of the company.

HTTP GET

Authentication: Not Required

Example 1

Request a system job category.

https://app.jobcast.net/api/v1.0/jobcategories/1

{
    "data":{
        "id":1,
        "name":"Accounting",
        "company":null
    },
    "warnings":[]
}
    

Example 2

Request a custom job category.

https://app.jobcast.net/api/v1.0/jobcategories/22

{
    "data":{
        "id":22,
        "name":"Aviation",
        "company":{"id":3}
    },
    "warnings":[]
}
    

HTTP POST

Allows you to create a custom job category. Since all custom job categories are company specific, a company property is required.

Authentication: Required

Parameters

Property	Type	Required?	Description
name	String (max 50)	✓	Human readable name for the job category.
company.id	Int32	✓	The unique identifier of the company.

Example

POST https://app.jobcast.net/api/v1.0/jobcategories HTTP/1.1
Host: app.jobcast.net
Content-Length: 38
Content-Type: application/json
Consumer-API-Key: a146471f-8e39-4e96-868f-19b9556a8297
User-API-Key: 0b52904c-1cf2-4572-8603-58d7673a1441

{"name":"Aviation","company":{"id":3}}
    

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Location: https://app.jobcast.net/api/v1.0/jobcategories/39
Content-Length: 69

{"data":{"id":22,"name":"Aviation","company":{"id":3}},"warnings":[]}
    

HTTP PUT

Allows you to modify a custom job category.

Authentication: Required

Parameters

Property	Type	Required?	Description
name	String (max 50)	No	Human readable name for the job category.

Example

PUT https://app.jobcast.net/api/v1.0/jobcategories/22 HTTP/1.1
Host: app.jobcast.net
Content-Length: 20
Content-Type: application/json
Consumer-API-Key: a146471f-8e39-4e96-868f-19b9556a8297
User-API-Key: 0b52904c-1cf2-4572-8603-58d7673a1441

{"name":"Aerospace"}
    

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 70

{"data":{"id":22,"name":"Aerospace","company":{"id":3}},"warnings":[]}
    

HTTP DELETE

Allows you to delete a custom job category, but only if it's not assigned to a job.

Authentication: Required

Example

DELETE https://app.jobcast.net/api/v1.0/jobcategories/22 HTTP/1.1
Host: app.jobcast.net
Consumer-API-Key: a146471f-8e39-4e96-868f-19b9556a8297
User-API-Key: 0b52904c-1cf2-4572-8603-58d7673a1441
    

HTTP/1.1 204 No Content
    

Job Categories List

Represents a list of job categories.

URI

https://app.jobcast.net/api/v1.0/jobcategories

HTTP GET

Authentication: Not Required

If no query string parameters are sent, only system job categories will be returned by default. To alter the list returned by the API, include the following query strings:

Query String

Paramter	Type	Required?	Description
company.id	Int32	No	Passing the company ID will also return the company's custom job categories, in addition to the system job categories.
active	String	No	This parameter is only meaningful if company.id is also included. The presence of this parameter will filter the list to only return job categories that are currently assigned to published jobs of the company.

Example 1

Request all system job categories.

https://app.jobcast.net/api/v1.0/jobcategories

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1030

{
    "data":[
        {"id":1,"name":"Accounting","company":null},
        {"id":2,"name":"Administrative","company":null},
        ...
        {"id":18,"name":"Software and Programming","company":null}
    ],
    "warnings":[]
}
    

---

Example 2

Request all system job categories and company's custom job categories.

https://app.jobcast.net/api/v1.0/jobcategories?company.id=3

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1496

{
    "data":[
        {"id":1,"name":"Accounting","company":null},
        {"id":2,"name":"Administrative","company":null},
        {"id":22,"name":"Aviation","company":{"id":3}},
        ...
        {"id":18,"name":"Software and Programming","company":null}
    ],
    "warnings":[]
}
    

---

Example 3

Request job categories that are currently assigned to published jobs for the company.

https://app.jobcast.net/api/v1.0/jobcategories?company.id=3&active=true

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 999

{
    "data":[
        {"id":22,"name":"Aviation","company":{"id":3}},
        ...
        {"id":18,"name":"Software and Programming","company":null}
    ],
    "warnings":[]
}