API

Quality management APIs

POST quality/document-collections/{documentCollectionId}/members

Adds a document to a document collection

HTTP method POST
URI https://api.rambase.net/quality/document-collections/{documentCollectionId}/members
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {documentCollectionId} Identifier of the document collection
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6280, 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
<Member>
2
     <QualityDocument>
3
          <QualityDocumentId
QualityDocumentId

Required/mandatory field

Identifier of the quality document

Minimum value: 1

>{Integer}</QualityDocumentId>
4
     </QualityDocument>
5
</Member>
1
{
2
     "member": {
3
          "qualityDocument": {
4
               "qualityDocumentId
QualityDocumentId

Required/mandatory field

Identifier of the quality document

Minimum value: 1

": "{Integer}"
5
          }
6
     }
7
}

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.

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

>
6
          <QualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Title of the document

>{String}</Title>
8
          <LastVersion>
9
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Possible domain values can be found here

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

Number of the latest document version.

>{Integer}</Version>
12
               <Author>
13
                    <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
17
               </Author>
18
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

>{String}</QualityDocumentVersionLink>
19
          </LastVersion>
20
          <QualityDocumentLink
QualityDocumentLink

API reference to the object

>{String}</QualityDocumentLink>
21
     </DeactivatedAt>
22
</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

": {
7
               "qualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Title of the document

": "{String}",
9
               "lastVersion": {
10
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Possible domain values can be found here

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

Number of the latest document version.

": "{Integer}",
13
                    "author": {
14
                         "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
18
                    },
19
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

": "{String}"
20
               },
21
               "qualityDocumentLink
QualityDocumentLink

API reference to the object

": "{String}"
22
          }
23
     }
24
}

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: