Human resource APIs
Creates a new item in course deplomas
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/courses/{courseId}/diplomas |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {courseId} |
Course identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2990, version 6 |
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 are required/mandatory.
StartDate
Date the course started
This field is optional.
>{Date}</StartDate>EndDate
Date the course ended
This field is optional.
>{Date}</EndDate>Employee
Required/mandatory field
The employee who received the course diploma
>EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
>{Integer}</EmployeeId>StartDate
Date the course started
This field is optional.
": "{Date}",EndDate
Date the course ended
This field is optional.
": "{Date}",Employee
Required/mandatory field
The employee who received the course diploma
": {EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
": "{Integer}"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.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
CourseDiplomaId
Course diplomas identifier
>{Integer}</CourseDiplomaId>CreatedAt
Date and time this diploma was created
>{Date}</CreatedAt>StartDate
Date the course started
>{Date}</StartDate>EndDate
Date the course ended
>{Date}</EndDate>NumberOfAttachments
The number of attachments this object has.
>{Integer}</NumberOfAttachments>Employee
The employee who received the course diploma
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>CourseId
Course identifier
>{Integer}</CourseId>Name
Name of course
>{String}</Name>CourseProvider
Name of the provider of the course
>{String}</CourseProvider>CourseLink
Course reference
>{String}</CourseLink>CourseDiplomaLink
Course diploma item link
>{String}</CourseDiplomaLink>CourseDiplomaId
Course diplomas identifier
": "{Integer}",CreatedAt
Date and time this diploma was created
": "{Date}",StartDate
Date the course started
": "{Date}",EndDate
Date the course ended
": "{Date}",NumberOfAttachments
The number of attachments this object has.
": "{Integer}",Employee
The employee who received the course diploma
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"CourseId
Course identifier
": "{Integer}",Name
Name of course
": "{String}",CourseProvider
Name of the provider of the course
": "{String}",CourseLink
Course reference
": "{String}"CourseDiplomaLink
Course diploma item link
": "{String}"
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:
| Error 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 103558 HTTP 400 | End date can not be less than start date |
| Error 103785 HTTP 400 | User is not authorized to add, delete or update courses for this employee |