Trainings

SkyHive’s Trainings API lets you retrieve information on training availability. With this API, you can:

  • View all trainings and their providers
  • View cost of trainings in the local currency

Trainings API Methods

You can retrieve information on trainings using these methods:

Get Training

Securityauth
Request
path Parameters
id
required
string
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/{id}
Request samples

Update Training

Securityauth
Request
path Parameters
id
required
string
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
approvalDate
string <date-time>
Array of objects (SkillDto)
status
string
Default: "active"
Enum: "none" "draft" "active" "archived"
object (DurationDto)
object (TrainingScrapModelDto)
visibility
Array of strings
tags
Array of strings
object
type
string
Default: "online"
Enum: "none" "online" "inclass" "hybrid"
level
string
Default: "beginner"
Enum: "none" "beginner" "intermediate" "advanced"
languages
Array of strings
firstAvailableDate
string <date-time>
lastAvailableDate
string <date-time>
object (Location)
instructionType
string
Default: "hybrid"
Enum: "hybrid" "selfPaced" "facilitated"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/trainings/{id}
Request samples
application/json
{
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "skills": [
    ],
  • "status": "none",
  • "duration": {
    },
  • "contentLength": {
    },
  • "scrapTraining": {
    },
  • "visibility": [
    ],
  • "tags": [
    ],
  • "metadata": {
    },
  • "type": "none",
  • "level": "none",
  • "languages": [
    ],
  • "firstAvailableDate": "2019-08-24T14:15:22Z",
  • "lastAvailableDate": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "instructionType": "hybrid"
}

Patch a Training

Securityauth
Request
path Parameters
id
required
string
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
Array
op
string

Use enum values to specify patch operation

Enum: "add" "remove" "replace"
path
string
value
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/trainings/{id}
Request samples
application/json
[
  • {
    }
]

Delete Training

Securityauth
Request
path Parameters
id
required
string
header Parameters
X-Enterprise-Id
required
string
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/trainings/{id}
Request samples

Search

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
resultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 10

Specifies the number of results to be returned

page
integer <int32> >= 0
Default: 0

Specifies the page number

minMatchPercentage
number <float> [ 1 .. 100 ]
Default: 20

Minimum match percentage

includeExternal
boolean
Default: false

Include trainings from external sources. Note that when a search is conducted that does not include a true value for this attribute, there might be no results.

status
string
Default: "active"

Status values to search for in trainings

Enum: "none" "active" "archived"
object (SearchConfig-3)

Configurations to tune search parameters

Array of objects (Skill-3) unique

skills to search in trainings

currencyCode
string

Currency Code to search in trainings

sortBy
string

Results to be sorted based on this field value

Enum: "quality" "price" "startDate"
providerIds
Array of strings

External training vendor Ids. See getProvidersList

visibility
Array of strings

visibility to be filtered for the Training

tags
Array of strings
title
string

Keyword search for training titles

levels
Array of strings (CourseLevel)
Items Enum: "None" "Beginner" "Intermediate" "Advanced"
courseTypes
Array of strings (CourseType)
Items Enum: "None" "Online" "InClass" "Hybrid"
languages
Array of strings
trainingDate
string <date-time>
object (LocationRequest)

Location information to search for the employee

instructionType
Array of strings (InstructionType)
Items Enum: "Hybrid" "SelfPaced" "Facilitated"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/trainings/search
Request samples
application/json
{
  • "resultsPerPage": 10,
  • "page": 0,
  • "minMatchPercentage": 20,
  • "includeExternal": false,
  • "status": "none",
  • "config": {
    },
  • "skills": [
    ],
  • "currencyCode": "string",
  • "sortBy": "quality",
  • "providerIds": [
    ],
  • "visibility": [
    ],
  • "tags": [
    ],
  • "title": "string",
  • "levels": [
    ],
  • "courseTypes": [
    ],
  • "languages": [
    ],
  • "trainingDate": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "instructionType": [
    ]
}

Create Training

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
approvalDate
string <date-time>
Array of objects (SkillDto)
status
string
Default: "active"
Enum: "none" "draft" "active" "archived"
object (DurationDto)
object (TrainingScrapModelDto)
visibility
Array of strings
tags
Array of strings
object
type
string
Default: "online"
Enum: "none" "online" "inclass" "hybrid"
level
string
Default: "beginner"
Enum: "none" "beginner" "intermediate" "advanced"
languages
Array of strings
firstAvailableDate
string <date-time>
lastAvailableDate
string <date-time>
object (Location)
instructionType
string
Default: "hybrid"
Enum: "hybrid" "selfPaced" "facilitated"
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/trainings/create
Request samples
application/json
{
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "skills": [
    ],
  • "status": "none",
  • "duration": {
    },
  • "contentLength": {
    },
  • "scrapTraining": {
    },
  • "visibility": [
    ],
  • "tags": [
    ],
  • "metadata": {
    },
  • "type": "none",
  • "level": "none",
  • "languages": [
    ],
  • "firstAvailableDate": "2019-08-24T14:15:22Z",
  • "lastAvailableDate": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "instructionType": "hybrid"
}

Get Providers List

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/providers
Request samples

Get Country Currency Conversions

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/currency
Request samples