API

Human resource APIs

GET human-resources/employees/{employeeId}/document-reading-requirements

Gets the list of competence statuses of the employee

HTTP method GET
URI https://api.rambase.net/human-resources/employees/{employeeId}/document-reading-requirements
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {employeeId} Employee identifier
Integer, minimum 100
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6511, version 15

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.

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.

$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

CloseToExpiration() Named filter Show all competence requirements that are close to expiration
Completed() Named filter Show all competence requirements that are completed
Expired() Named filter Show all competence requirements that are expired
PendingAction() Named filter Show all competence requirements that require pending action by others
AuthorId Integer Employee identifier.
ContainingCompetenceProfileId Integer Filter on document reading requirements containing a specific competence profile.
ContainingDocumentCollectionId Integer Filter on document reading requirements containing a specific document collection.
ContentType String Document type. Can be quiz, message, file url or structured content.
CosignedById Integer Employee identifier.
DocumentTitle String New title of the document, which will be updated when version is approved.
ExpiresAt Datetime Date and time the document should be read within. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
QualityDocumentId Integer Identifier of the quality document.
Status Integer Status on the competence. 1: Not started, 3: Pending action by others, 4: Completed, 9: Discontinued.
UpdatedAt Datetime Automatically generated timestamp when a competence status is updated. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

Read more about filters and sorting on how to use sortable parameters

ContentType String Document type. Can be quiz, message, file url or structured content

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
<DocumentReadingRequirements>
2
     <DocumentReadingRequirement>
3
          <Status
Status

Status on the competence. 1: Not started, 3: Pending action by others, 4: Completed, 9: Discontinued

Possible domain values can be found here

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

Date and time document was co-signed

>{Datetime}</CosignedAt>
5
          <ReadAt
ReadAt

Date and time the document was read

>{Datetime}</ReadAt>
6
          <UpdatedAt
UpdatedAt

Automatically generated timestamp when a competence status is updated

>{Datetime}</UpdatedAt>
7
          <ExpiresAt
ExpiresAt

Date and time the document should be read within

>{Datetime}</ExpiresAt>
8
          <CoSignRequirement
CoSignRequirement

What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"

Possible domain values can be found here

>{Integer}</CoSignRequirement>
9
          <CosignMessages
CosignMessages

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>
10
               <CosignMessage
CosignMessage

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>
11
                    <SentAt
SentAt

Timestamp of sending the message

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{Datetime}</SentAt>
12
                    <Message
Message

Message attached to the rejection of the co-sign

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{String}</Message>
13
                    <SentBy
SentBy

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>
14
                         <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{Integer}</EmployeeId>
15
                         <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{String}</EmployeeLink>
16
                    </SentBy>
17
                    <SentTo
SentTo

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>
18
                         <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{Integer}</EmployeeId>
19
                         <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

>{String}</EmployeeLink>
20
                    </SentTo>
21
               </CosignMessage>
22
          </CosignMessages>
23
          <QualityDocumentVersion>
24
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

>{Integer}</QualityDocumentVersionId>
25
               <Title
Title

New title of the document, which will be updated when version is approved.

>{String}</Title>
26
               <ContentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

>{String}</ContentType>
27
               <Author
Author

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

>
28
                    <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

>{Integer}</EmployeeId>
29
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

>{String}</LastName>
30
                    <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

>{String}</FirstName>
31
                    <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

>{String}</EmployeeLink>
32
               </Author>
33
               <QualityDocument>
34
                    <QualityDocumentId
QualityDocumentId

Identifier of the quality document

>{Integer}</QualityDocumentId>
35
                    <Title
Title

Title of the document

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.QualityDocument.Title in your request URI to get this field

>{String}</Title>
36
                    <QualityDocumentLink
QualityDocumentLink

Quality document reference

>{String}</QualityDocumentLink>
37
               </QualityDocument>
38
               <QualityDocumentVersionLink
QualityDocumentVersionLink

>{String}</QualityDocumentVersionLink>
39
          </QualityDocumentVersion>
40
          <CosignedBy>
41
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
42
               <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignedBy.FirstName in your request URI to get this field

>{String}</FirstName>
43
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignedBy.LastName in your request URI to get this field

>{String}</LastName>
44
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
45
          </CosignedBy>
46
     </DocumentReadingRequirement>
47
     <Paging
Paging

Detailed paging information for this list.

>
48
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
49
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
50
          <Page
Page

Page index

>{Integer}</Page>
51
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
52
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
53
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
54
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
55
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
56
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
57
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
58
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
59
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
60
     </Paging>
61
</DocumentReadingRequirements>
1
{
2
     "documentReadingRequirements": [
3
          {
4
               "status
Status

Status on the competence. 1: Not started, 3: Pending action by others, 4: Completed, 9: Discontinued

Possible domain values can be found here

": "{Integer}",
5
               "cosignedAt
CosignedAt

Date and time document was co-signed

": "{Datetime}",
6
               "readAt
ReadAt

Date and time the document was read

": "{Datetime}",
7
               "updatedAt
UpdatedAt

Automatically generated timestamp when a competence status is updated

": "{Datetime}",
8
               "expiresAt
ExpiresAt

Date and time the document should be read within

": "{Datetime}",
9
               "coSignRequirement
CoSignRequirement

What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"

Possible domain values can be found here

": "{Integer}",
10
               "cosignMessages
CosignMessages

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": [
11
                    {
12
                         "sentAt
SentAt

Timestamp of sending the message

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{Datetime}",
13
                         "message
Message

Message attached to the rejection of the co-sign

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{String}",
14
                         "sentBy
SentBy

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": {
15
                              "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{Integer}",
16
                              "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{String}"
17
                         },
18
                         "sentTo
SentTo

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": {
19
                              "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{Integer}",
20
                              "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignMessages in your request URI to get this field

": "{String}"
21
                         }
22
                    }
23
               ],
24
               "qualityDocumentVersion": {
25
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

": "{Integer}",
26
                    "title
Title

New title of the document, which will be updated when version is approved.

": "{String}",
27
                    "contentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

": "{String}",
28
                    "author
Author

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

": {
29
                         "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

": "{Integer}",
30
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

": "{String}",
31
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

": "{String}",
32
                         "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.Author in your request URI to get this field

": "{String}"
33
                    },
34
                    "qualityDocument": {
35
                         "qualityDocumentId
QualityDocumentId

Identifier of the quality document

": "{Integer}",
36
                         "title
Title

Title of the document

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.QualityDocumentVersion.QualityDocument.Title in your request URI to get this field

": "{String}",
37
                         "qualityDocumentLink
QualityDocumentLink

Quality document reference

": "{String}"
38
                    },
39
                    "qualityDocumentVersionLink": "{String}"
40
               },
41
               "cosignedBy": {
42
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
43
                    "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignedBy.FirstName in your request URI to get this field

": "{String}",
44
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=DocumentReadingRequirement.CosignedBy.LastName in your request URI to get this field

": "{String}",
45
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
46
               }
47
          }
48
     ],
49
     "paging
Paging

Detailed paging information for this list.

": {
50
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
51
          "position
Position

Position of the first element in the list

": "{Integer}",
52
          "page
Page

Page index

": "{Integer}",
53
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
54
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
55
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
56
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
57
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
58
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
59
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
60
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
61
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
62
     }
63
}

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: