API

Quality management APIs

GET quality/document-collections/{documentCollectionId}/members/{memberId}

Gets a document reference for a document in a document collection

HTTP method GET
URI https://api.rambase.net/quality/document-collections/{documentCollectionId}/members/{memberId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {documentCollectionId} Identifier of the document collection
Integer, minimum 100000
- URI parameter {memberId} Document collection document identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6279, version 5

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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. 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
<Member>
2
     <MemberId
MemberId

Document collection document identifier

>{Integer}</MemberId>
3
     <Status
Status

Status of the document collection document. 4: Active, 9: Deactivated

Possible domain values can be found here

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

Date and time the document collection member was added

>{Datetime}</AddedAt>
5
     <DeactivatedAt
DeactivatedAt

Date and time the document collection document was deactivated

>{Datetime}</DeactivatedAt>
6
     <QualityDocument
QualityDocument

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

>
7
          <QualityDocumentId
QualityDocumentId

Identifier of the quality document

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

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

Title of the document

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

>{String}</Title>
9
          <DisplayTitle
DisplayTitle

Title generated according to the system setting.

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

>{String}</DisplayTitle>
10
          <LastVersion
LastVersion

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

>
11
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

>{Integer}</QualityDocumentVersionId>
12
               <ContentType
ContentType

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

Possible domain values can be found here

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

>{String}</ContentType>
13
               <Version
Version

Number of the latest document version.

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

>{Integer}</Version>
14
               <Author
Author

This field is greyed out because it is an expandable field. You have to add $expand=QualityDocument 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=QualityDocument in your request URI to get this field

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
19
               </Author>
20
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

>{String}</QualityDocumentVersionLink>
21
          </LastVersion>
22
          <QualityDocumentLink
QualityDocumentLink

API reference to the object

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

>{String}</QualityDocumentLink>
23
     </QualityDocument>
24
</Member>
1
{
2
     "member": {
3
          "memberId
MemberId

Document collection document identifier

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

Status of the document collection document. 4: Active, 9: Deactivated

Possible domain values can be found here

": "{Integer}",
5
          "addedAt
AddedAt

Date and time the document collection member was added

": "{Datetime}",
6
          "deactivatedAt
DeactivatedAt

Date and time the document collection document was deactivated

": "{Datetime}",
7
          "qualityDocument
QualityDocument

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

": {
8
               "qualityDocumentId
QualityDocumentId

Identifier of the quality document

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

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

Title of the document

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

": "{String}",
10
               "displayTitle
DisplayTitle

Title generated according to the system setting.

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

": "{String}",
11
               "lastVersion
LastVersion

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

": {
12
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

": "{Integer}",
13
                    "contentType
ContentType

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

Possible domain values can be found here

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

": "{String}",
14
                    "version
Version

Number of the latest document version.

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

": "{Integer}",
15
                    "author
Author

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

": {
16
                         "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

": "{String}"
20
                    },
21
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

": "{String}"
22
               },
23
               "qualityDocumentLink
QualityDocumentLink

API reference to the object

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

": "{String}"
24
          }
25
     }
26
}

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: