GET human-resources/courses

List of courses for human resources

Note: Log in to check if your API client have access to run this resource
Version: 7
Success HTTP Status Code: 200
Maximum items from list ($top): 80

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

CourseId Integer Course identifier.
CourseProvider String Name of the provider of the course.
CreatedAt Datetime Date and time of creation. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String Description of the course.
ExclusivelyForDatabase String Company this course belongs to. Available macros: currentDB()
Length String Length of the course in hours.
Name String Name of course.
Status Integer Status of course.

See the page about filters and sorting on how to use sortable parameters

CourseId Integer Course identifier
CourseProvider String Name of the provider of the course
CreatedAt Datetime Date and time of creation
Description String Description of the course
ExclusivelyForDatabase String Company this course belongs to
Length String Length of the course in hours
Name String Name of course
Status Integer Status of course

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Courses>
2
     <Course>
3
          <CourseId
CourseId

Course identifier

>
{Integer}</CourseId>
4
          <Status
Status

Status of course

Possible domain values can be found here when logged in

>
{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
6
          <Name
Name

Name of course

>
{String}</Name>
7
          <CourseProvider
CourseProvider

Name of the provider of the course

>
{String}</CourseProvider>
8
          <Length
Length

Length of the course in hours

>
{String}</Length>
9
          <Description
Description

Description of the course

>
{String}</Description>
10
          <ExclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

>
11
               <CompanyId
CompanyId

Company identifier

>
{Integer}</CompanyId>
12
               <Database
Database

Abbreviation/code to identify the company

>
{String}</Database>
13
               <CompanyLink
CompanyLink

Company reference

>
{String}</CompanyLink>
14
          </ExclusivelyForCompany>
15
          <CourseLink
CourseLink

Course reference

>
{String}</CourseLink>
16
     </Course>
17
</Courses>
1
{
2
     "courses": [
3
          {
4
               "courseId
CourseId

Course identifier

":
"{Integer}",
5
               "status
Status

Status of course

Possible domain values can be found here when logged in

":
"{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
               "name
Name

Name of course

":
"{String}",
8
               "courseProvider
CourseProvider

Name of the provider of the course

":
"{String}",
9
               "length
Length

Length of the course in hours

":
"{String}",
10
               "description
Description

Description of the course

":
"{String}",
11
               "exclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

":
{
12
                    "companyId
CompanyId

Company identifier

":
"{Integer}",
13
                    "database
Database

Abbreviation/code to identify the company

":
"{String}",
14
                    "companyLink
CompanyLink

Company reference

":
"{String}"
15
               },
16
               "courseLink
CourseLink

Course reference

":
"{String}"
17
          }
18
     ]
19
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: