API

Production APIs

GET production/mrb-specifications/{mrbSpecificationId}

View details of a MRB specification

HTTP method GET
URI https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {mrbSpecificationId} MRB specification identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5538, version 7

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.

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
<MRBSpecification>
2
     <MRBSpecificationId
MRBSpecificationId

MRB specification identifier

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

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

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

Descrtiptive name for this book template

>{String}</Description>
5
     <CreatedAt
CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

>{Datetime}</CreatedAt>
6
     <TemplateFile
TemplateFile

Reference to the template pdf file version to be used in the MRB

>
7
          <FileVersionId
FileVersionId

Version of the file

>{Integer}</FileVersionId>
8
          <File
File

Reference to the template pdf file to be used in the MRB

>
9
               <FileId
FileId

File identifier

>{Integer}</FileId>
10
               <FileLink
FileLink

File reference

>{String}</FileLink>
11
          </File>
12
          <FileVersionLink
FileVersionLink

File version reference

>{String}</FileVersionLink>
13
     </TemplateFile>
14
     <ExclusivelyFor>
15
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
16
          <ObjectType
ObjectType

Type of object

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

First name of the customer/supplier

>{String}</FirstName>
18
          <Name
Name

Name of the customer/supplier, or last name if it is a person.

>{String}</Name>
19
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
20
     </ExclusivelyFor>
21
</MRBSpecification>
1
{
2
     "mRBSpecification": {
3
          "mRBSpecificationId
MRBSpecificationId

MRB specification identifier

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

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

": "{Integer}",
5
          "description
Description

Descrtiptive name for this book template

": "{String}",
6
          "createdAt
CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

": "{Datetime}",
7
          "templateFile
TemplateFile

Reference to the template pdf file version to be used in the MRB

": {
8
               "fileVersionId
FileVersionId

Version of the file

": "{Integer}",
9
               "file
File

Reference to the template pdf file to be used in the MRB

": {
10
                    "fileId
FileId

File identifier

": "{Integer}",
11
                    "fileLink
FileLink

File reference

": "{String}"
12
               },
13
               "fileVersionLink
FileVersionLink

File version reference

": "{String}"
14
          },
15
          "exclusivelyFor": {
16
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
17
               "objectType
ObjectType

Type of object

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

First name of the customer/supplier

": "{String}",
19
               "name
Name

Name of the customer/supplier, or last name if it is a person.

": "{String}",
20
               "objectLink
ObjectLink

API reference to the object

": "{String}"
21
          }
22
     }
23
}

Possible error codes the response might return:

Error 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers