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:

Use getTraining to retrieve the details for a single course.
Use updateTraining to update the details for a single course.
Use deleteTraining to retrieve the details for a single course.
Use search to search for training that provides specific skills.
Use createTraining to add a new course.
Use getProvidersList to view trainings and related information.
Use getCountryCurrencyConversions to look up currency exchange rates for countries.

Get Training

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/{id}

Request samples

curl
JavaScript
Python
Java

Update Training

Securityauth

Request

path Parameters

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/trainings/{id}

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"approvalDate": "2019-08-24T14:15:22Z",
"skills": [{"id": "string",
"level": "Entry",
"title": "string"
}
],
"status": "none",
"duration": {"displayText": "5 hours",
"value": 5,
"unit": "Hours",
"valueInSeconds": 18000
},
"contentLength": {"displayText": "5 hours",
"value": 5,
"unit": "Hours",
"valueInSeconds": 18000
},
"scrapTraining": {"title": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"uri": "string",
"trainingCode": "Reskilling-World-101",
"providerName": "SkyHive",
"price": {"primaryValue": 13.83,
"primaryCurrency": "CAD",
"usdValue": 10
},
"description": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"shortDescription": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"descriptionPlainText": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"shortDescriptionPlainText": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"providerId": "dadebe455cf84ccbbf62cbdd"
},
"visibility": ["string"
],
"tags": ["string"
],
"metadata": {"property1": "string",
"property2": "string"
},
"type": "none",
"level": "none",
"languages": ["string"
],
"firstAvailableDate": "2019-08-24T14:15:22Z",
"lastAvailableDate": "2019-08-24T14:15:22Z",
"location": {"formattedAddress": "SkyHive, Cowper Street, Palo Alto, CA, USA",
"addressLine1": "430 Cowper Street",
"addressLine2": "Suite 250",
"municipality": "Palo Alto",
"postcode": "94301",
"country": "US",
"country3": "USA",
"state": "California",
"stateShort": "CA"
},
"instructionType": "hybrid"
}

Patch a Training

Securityauth

Request

path Parameters

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/trainings/{id}

Request samples

Payload
curl
JavaScript
Python
Java

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Delete Training

Securityauth

Request

path Parameters

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

curl
JavaScript
Python
Java

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
fuzzyTitle	string Keyword search for training titles alias
exactTitle	string Keyword search for training exact 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/trainings/search

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"resultsPerPage": 10,
"page": 0,
"minMatchPercentage": 20,
"includeExternal": false,
"status": "none",
"config": {"nullOrEmptySkills": true,
"algorithm": "default"
},
"skills": [{"level": "entry",
"id": "string",
"title": "string",
"weight": 1,
"relevance": 1,
"type": "technical"
}
],
"currencyCode": "string",
"sortBy": "quality",
"providerIds": ["string"
],
"visibility": ["string"
],
"tags": ["string"
],
"title": "string",
"fuzzyTitle": "string",
"exactTitle": "string",
"levels": ["None"
],
"courseTypes": ["None"
],
"languages": ["string"
],
"trainingDate": "2019-08-24T14:15:22Z",
"location": {"formattedAddress": "string",
"addressLine1": "string",
"addressLine2": "string",
"municipality": "string",
"postcode": "string",
"country": "string",
"country3": "string",
"state": "string",
"stateShort": "string",
"locationHandle": "zlGRkTEdwMmUIDM3X9ymrS9wlGOyj/aNow57+P5j2L6qUe7sNI2cgS/SKmxHG/EYMCkmCq8b7s83pMVab6RTBC0pPS6oQSwLKCPln8HB1RuPmP+Q34y9yrHUiw08ZBe7pN7yKhI0IwI3vzwMXSqoaz+lMCfDNbRSniEOtifMEoYnIsIPYN/61+Hb4FzS7mP07+nrl1zfPuDI+lWttxziBhGAbbT30jlMbQ1o2hAMGLJYhl0jTrb6YsL6O7IALkrI3BX4vDOKbiLD2NZIhkSKWM3+RPTMruVxr9A4oNrTzTtZj/ftHU4grr5Nh1lDPBa0+1e9aRZuu9CqP/QTu6K6gg==",
"radius": 20,
"longitude": 0,
"latitude": 0
},
"instructionType": ["Hybrid"
]
}

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

Payload
curl
JavaScript
Python
Java

application/json

{"approvalDate": "2019-08-24T14:15:22Z",
"skills": [{"id": "string",
"level": "Entry",
"title": "string"
}
],
"status": "none",
"duration": {"displayText": "5 hours",
"value": 5,
"unit": "Hours",
"valueInSeconds": 18000
},
"contentLength": {"displayText": "5 hours",
"value": 5,
"unit": "Hours",
"valueInSeconds": 18000
},
"scrapTraining": {"title": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"uri": "string",
"trainingCode": "Reskilling-World-101",
"providerName": "SkyHive",
"price": {"primaryValue": 13.83,
"primaryCurrency": "CAD",
"usdValue": 10
},
"description": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"shortDescription": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"descriptionPlainText": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"shortDescriptionPlainText": {"title": [{"languageCode": "en-US",
"value": "Reskilling the World 101"
}
]
},
"providerId": "dadebe455cf84ccbbf62cbdd"
},
"visibility": ["string"
],
"tags": ["string"
],
"metadata": {"property1": "string",
"property2": "string"
},
"type": "none",
"level": "none",
"languages": ["string"
],
"firstAvailableDate": "2019-08-24T14:15:22Z",
"lastAvailableDate": "2019-08-24T14:15:22Z",
"location": {"formattedAddress": "SkyHive, Cowper Street, Palo Alto, CA, USA",
"addressLine1": "430 Cowper Street",
"addressLine2": "Suite 250",
"municipality": "Palo Alto",
"postcode": "94301",
"country": "US",
"country3": "USA",
"state": "California",
"stateShort": "CA"
},
"instructionType": "hybrid"
}

Get Providers List

Securityauth

Request

header Parameters

X-Enterprise-Id

required

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/providers

Request samples

curl
JavaScript
Python
Java

Get Country Currency Conversions

Securityauth

Request

header Parameters

X-Enterprise-Id

required

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/trainings/currency

Request samples

curl
JavaScript
Python
Java

➔ Next to Normalization

Trainings

Trainings API Methods

Get Training

path Parameters

header Parameters

Update Training

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Patch a Training

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete Training

path Parameters

header Parameters

Search

header Parameters

Request Body schema: application/jsonrequired

Create Training

header Parameters

Request Body schema: application/jsonrequired

Get Providers List

header Parameters

Get Country Currency Conversions

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required