Human resource APIs
Creates a new item in issued certificates for an employee
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/certificates/{certificateId}/issued-certificates |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {certificateId} |
Certificate identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2950, version 12 |
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.
Employee
Required/mandatory field
The employee who aquired the certificate
>EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
>{Integer}</EmployeeId>Validity
This field is optional.
>EffectiveDate
Valid from
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
Valid to
This field is optional.
>{Date}</ExpirationDate>Employee
Required/mandatory field
The employee who aquired the certificate
": {EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
": "{Integer}"Validity
This field is optional.
": {EffectiveDate
Valid from
This field is optional.
": "{Date}",ExpirationDate
Valid to
This field is optional.
": "{Date}"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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $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.
IssuedCertificateId
Issued certificate item identifier
>{Integer}</IssuedCertificateId>CreatedAt
Date and time this acquired certificate was created
>{Datetime}</CreatedAt>Status
Status of the acquired certificate item
Possible domain values can be found here
>{Integer}</Status>NumberOfAttachments
The number of attachments this object has.
>{Integer}</NumberOfAttachments>Employee
The employee who aquired the certificate
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>CertificateId
Certificate identifier
>{Integer}</CertificateId>Name
Name of certificate
>{String}</Name>Issuer
Issuer of certificate
>{String}</Issuer>CertificateLink
Certificate reference
>{String}</CertificateLink>EffectiveDate
Valid from
>{Date}</EffectiveDate>ExpirationDate
Valid to
>{Date}</ExpirationDate>IssuedCertificateId
Issued certificate item identifier
": "{Integer}",CreatedAt
Date and time this acquired certificate was created
": "{Datetime}",Status
Status of the acquired certificate item
Possible domain values can be found here
": "{Integer}",NumberOfAttachments
The number of attachments this object has.
": "{Integer}",Employee
The employee who aquired the certificate
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"CertificateId
Certificate identifier
": "{Integer}",Status
Status of certificate
Possible domain values can be found here
": "{Integer}",Name
Name of certificate
": "{String}",Issuer
Issuer of certificate
": "{String}",CertificateLink
Certificate reference
": "{String}"EffectiveDate
Valid from
": "{Date}",ExpirationDate
Valid to
": "{Date}"
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 103529 HTTP 400 | Valid to-date can not be less than valid from-date |
| Error 103799 HTTP 400 | User is not authorized to add, delete or update certificates for this employee |