API

Production APIs

GET production/mrb-specifications

Lists all MRB templates

HTTP method GET
URI https://api.rambase.net/production/mrb-specifications
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5537, version 9

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.

Active() Named filter Active MRB specifications
Discontinued() Named filter Discontinued MRB specifications
CustomerAccountId String Customer identifier.
Description String Descrtiptive name for this book template.
MrbSpecificationId Integer MRB specification identifier.
Status Integer Status indicator for Active, edit or obsoleted book.
SupplierAccountId Integer RamBase supplier identifier.
TemplateFileId String Reference to the template pdf file to be used in the MRB.

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

CustomerAccountId String Customer identifier
Description String Descrtiptive name for this book template
MrbSpecificationId Integer MRB specification identifier
Status Integer Status indicator for Active, edit or obsoleted book
SupplierAccountId Integer RamBase supplier identifier
TemplateFileId String Reference to the template pdf file to be used in the MRB

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

MRB specification identifier

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

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

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

Descrtiptive name for this book template

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

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

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

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

>
8
               <FileVersionId
FileVersionId

Version of the file

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

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

>
10
                    <FileId
FileId

File identifier

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

File reference

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

File version reference

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

Identifier of the object

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

Type of object

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

First name of the customer/supplier

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

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

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

API reference to the object

>{String}</ObjectLink>
21
          </ExclusivelyFor>
22
          <MRBSpecificationLink
MRBSpecificationLink

Full reference to the book.

>{String}</MRBSpecificationLink>
23
     </MRBSpecification>
24
     <Paging
Paging

Detailed paging information for this list.

>
25
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
28
          <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>
29
          <FirstPage
FirstPage

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

>{String}</FirstPage>
30
          <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>
31
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
32
          <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>
33
          <NextPage
NextPage

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

>{String}</NextPage>
34
          <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>
35
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
37
     </Paging>
38
</MRBSpecifications>
1
{
2
     "mRBSpecifications": [
3
          {
4
               "mRBSpecificationId
MRBSpecificationId

MRB specification identifier

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

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

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

Descrtiptive name for this book template

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

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

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

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

": {
9
                    "fileVersionId
FileVersionId

Version of the file

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

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

": {
11
                         "fileId
FileId

File identifier

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

File reference

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

File version reference

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

Identifier of the object

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

Type of object

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

First name of the customer/supplier

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

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

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

API reference to the object

": "{String}"
22
               },
23
               "mRBSpecificationLink
MRBSpecificationLink

Full reference to the book.

": "{String}"
24
          }
25
     ],
26
     "paging
Paging

Detailed paging information for this list.

": {
27
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
30
          "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}",
31
          "firstPage
FirstPage

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

": "{String}",
32
          "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}",
33
          "previousPage
PreviousPage

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

": "{String}",
34
          "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}",
35
          "nextPage
NextPage

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

": "{String}",
36
          "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}",
37
          "lastPage
LastPage

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

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

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

": "{Integer}"
39
     }
40
}

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 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers