Ninth Brain API Documentation
  1. Ninth Brain API Documentation
  2. /
  3. Resources
  4. /
  5. Individual Certifications

Individual Certifications

Types

The GetIndividualCertificationList object

Field Type Description
HasMoreResults bool indicates if there are more results
Offset int Number of results skipped. Will match the parameter passed into the endpoint.
ResultCount int Number of results returned.
Data array of IndividualCertification objects Shift assignments requested.

The IndividualCertification object

Field Type Description
IndividualCertificationId int Unique identifier created by NBS.
NBSId int Unique identifier created by NBS
FirstName string
LastName string
JobTitleId int Ninth Brain’s internal unqiue id for the job title
JobTitle string See Job Title Resource
AdditionalJobTitles List of JobTitles This is readonly property, will not be used in inserts/updates.
CertificationId int Maps to the certification object
CertificationName string
CertificationNumber string
State string State the certification is related to
Country string Country the certification is related to
ActivationDate date
ExpirationDate date
Reference string Optional field to enter a brief note that is specific to this credential.
UpdateDate date (read only) Date the individual certification was last updated.
IsMaintained boolean (read only) Is the credential marked maintained in NBS.
IssuingBody string (Optional) The issuing body for the credential.

The GetRequiredCertificationStatusResult object

Field Type Description
HasMoreResults bool indicates if there are more results
Offset int Number of results skipped. Will match the parameter passed into the endpoint.
ResultCount int Number of results returned.
Data array of EmployeeRequiredCredentialStatus objects The credential requirement statuses requested.

The EmployeeRequiredCredentialStatus object

Field Type Description
Employment Object Employees details
CredentialRequirements Array of IndividualRequiredCertificationRequirement objects The credentials required and their status for the employee

The EmploymentDetails object

Field Type Description
NBSId Integer Unique identifier created by NBS
UniqueIdentifier String
EmployeeNumber String
FirstName String
LastName String

The IndividualRequiredCertificationRequirement object

Field Type Description
JobTitle RequiringJobTitle object Always returned. Describes the job that has the requirements.
Locale RequiringLocale object Only returned if the requirement is specfic to particular locale. Not enabled for all companies.
RequirementsMet Boolean True if no required credentials are expired or missing.
Requirements Array of IndividualRequiredCertification objects Details of the credentails required for the job title/locale.

The RequiringJobTitle object

Field Type Description
JobTitleId Integer NBS generated unique ID
JobTitleName String

The RequiringLocale object

Field Type Description
LocaleId Integer NBS generated unique ID
LocaleName String Also known as “Business Unit”
BusinessUnitId String Unique BusinessUnitId provided by customer. Not enabled for all companies.

The IndividualRequiredCertification object

Field Type Description
Requirement String Human readable description of the required credential(s) or credential type(s)
RequirementStatus String Status of the requirement:
Missing, Current, Expired, NotMaintained
FulfillingCertification CertificationDetails object Details of the related credential if RequirementStatus != “Missing”

The CertificationDetails object

Field Type Description
CertificationName String
CertificationNumber String
ActivationDate String Format: yyyy-MM-dd
ExpirationDate String Format: yyyy-MM-dd

Endpoints

Get Individual Certification List

Returns latest version of all certifications

Authorization needed

Request 
GET https://api.ninthbrain.com/IndividualCertification/GetIndividualCertificationList?updatedSince=2022-03-21&UniqueIdentifier=ABC123&api-version=2.0

Query Parameters

Name Type Required Description
updatedSince date optional If provided only credentials updated the provided date are returned.
NBSId integer optional Used to return credentials for a single employee.
UniqueIdentifier String optional Used to return credentials for a single employee.
EmployeeNumber String optional Used to return credentials for a single employee.
Offset int optional Used for paging results. Number of records to skip. Defaults to 0.
Limit int optional Used for paging results. Max number of results to return, must be between 1-200. Defaults to 200.
Example response 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
    "HasMoreResults": false,
    "Offset": 0,
    "ResultCount": 1,
    "Data": [
		{
			"IndividualCertificationId": 123456,
			"NBSId": 12345,
			"FirstName": "John",
			"LastName": "Doe",
			"JobTitleId":12345,
			"JobTitle":"Paramedic"
			"AdditionalJobTitles"
				{
				"JobTitleId":123
				"JobTitleName":"EMT"
				}
			"CertificationId": 123,
			"CertificationName": "Certification Name",
			"CertificationNumber": "CertNumber123",
			"State": "",
			"Country": "",
			"ActivationDate": "2021-06-09T00:00:00-04:00",
			"ExpirationDate": "2023-06-20T00:00:00-04:00",
			"Reference": "",
			"UpdateDate": "2021-06-30T15:36:45.257-04:00",		
			"IsMaintained": True
		}
	]
}
Errors
  • bad_request (HTTP 400)
  • unauthorized (HTTP 401) - This APIKey is not valid for this service.
  • not_found (HTTP 404) - Invalid NBSId/UniqueIdentifier/EmployeeNumber provided.

Insert Individual Certification

Request 
POST https://api.ninthbrain.com/IndividualCertification/Insert?api-version=2.0
Request Body 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "NBSId": 0,
  "CertificationId": 0,
  "CertificationNumber": "",
  "Reference": "",
  "ActivationDate": "2014-04-14T22:09:50.124896-04:00",
  "ExpirationDate": "2014-04-14T22:09:50.125896-04:00"
}
Example response 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "IndividualCertificationId": 0,
  "NBSId": 0,
  "FirstName": "",
  "LastName": "",
  "CertificationId": 0,
  "CertificationName": "",
  "CertificationNumber": "",
  "ActivationDate": "2014-04-14T22:09:50.124896-04:00",
  "ExpirationDate": "2014-04-14T22:09:50.125896-04:00",
  "Reference": "",
  "UpdateDate": "2014-04-14T22:09:50.125896-04:00",		
  "IsMaintained": True
}
Errors
  • unauthorized (HTTP 401) - invalid credentials (bearer token) supplied
  • not_modified (HTTP 304) - error occurred
  • bad request (HTTP 400) - unknown error occurred

Get Required Certification Status

Returns the credential required for each employee’s job title and the status of that requirement.

Request 
GET https://api.ninthbrain.com/IndividualCertification/GetRequiredCertificationStatus?api-version=2.0

Query Parameters

Name Type Required Description
NBSId Integer optional If provided a single employee’s required credentials will be returned.
UniqueIdentifier String optional If provided a single employee’s required credentials will be returned.
EmployeeNumber String optional If provided a single employee’s required credentials will be returned.
Offset int optional Used for paging results. Number of records to skip. Defaults to 0.
Limit int optional Used for paging results. Max number of results to return, must be between 1-200. Defaults to 200.
Example response 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
    "HasMoreResults": false,
    "Offset": 0,
    "ResultCount": 1,
    "Data": [{
            "Employment": {
                "NBSId": 1234,
                "UniqueIdentifier": "ID1234",
                "EmployeeNumber": "ID1234123ABC",
                "FirstName": "Jane",
                "LastName": "doe"
            },
            "CredentialRequirements": [{
                    "JobTitle": {
                        "JobTitleId": 1234,
                        "JobTitleName": "EMT Basic"
                    },
                    "Locale": {
                        "LocaleId": 1234,
                        "LocaleName": "Demo Locale",
                        "BusinessUnitId": "BU-123"
                    },
                    "RequirementsMet": false,
                    "Requirements": [
                        {
                            "Requirement": "Type: BLS",
                            "RequirementStatus": "Current",
                            "FulfillingCertification": {
                                "CertificationName": "BLS/CPR Instructor (Basic Life Support/Cardiopulmonary Resuscitation Instructor)",
                                "CertificationNumber": "Testing123",
                                "ActivationDate": "2024-08-10",
                                "ExpirationDate": "2024-11-29"
                            }
                        }, 
                        {
                            "Requirement": "Driver's License - State",
                            "RequirementStatus": "Missing",
                            "FulfillingCertification": null
                        }
                    ]
                }
            ]
        }
    ]
}
Errors
  • unauthorized (HTTP 401) - invalid credentials (bearer token) supplied
  • not_modified (HTTP 304) - error occurred
  • bad request (HTTP 400) - unknown error occurred