Production APIs
Create a new content page for the MRB specification
| HTTP method | POST |
| URI | https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}/sections/{sectionId}/contents |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {mrbSpecificationId} |
MRB specification identifier
Integer, minimum 100000 |
| - URI parameter {sectionId} |
Book section identifier
Integer, minimum 1 |
| Successful HTTP status code | 201 |
| API resource identifier | 5561, version 4 |
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.
BookmarkTitle
Title for the content page. This title supports macros like {n} for a running number, {nn} for a 0-prefixed running number, {pwoid} as a reference to the PWO id.
This field is optional.
>{String}</BookmarkTitle>Type
Required/mandatory field
Domain value to determine the type of content. Values are: Files, Template page
Applicable domain values can be found here
>{Integer}</Type>TemplateFilePageNumber
Reference that points to a specific page number in the Template PDF to be added to the MRB.
Minimum value: 1
This field is optional.
>{Integer}</TemplateFilePageNumber>Separator
Separator page between documents added to the MRB. This is a macro and indicates an internal incremental number: {n}. Additional text can be added to better indicate end of document and start of new document.
This field is optional.
>{String}</Separator>BookmarkTitle
Title for the content page. This title supports macros like {n} for a running number, {nn} for a 0-prefixed running number, {pwoid} as a reference to the PWO id.
This field is optional.
": "{String}",Type
Required/mandatory field
Domain value to determine the type of content. Values are: Files, Template page
Applicable domain values can be found here
": "{Integer}",TemplateFilePageNumber
Reference that points to a specific page number in the Template PDF to be added to the MRB.
Minimum value: 1
This field is optional.
": "{Integer}",Separator
Separator page between documents added to the MRB. This is a macro and indicates an internal incremental number: {n}. Additional text can be added to better indicate end of document and start of new document.
This field is optional.
": "{String}"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.
ContentId
Identifier for section content
>{Integer}</ContentId>CreatedAt
Date and time stamp this content was created
>{Datetime}</CreatedAt>Type
Domain value to determine the type of content. Values are: Files, Template page
Possible domain values can be found here
>{Integer}</Type>Description
Description of content
>{String}</Description>BookmarkTitle
Title for the content page. This title supports macros like {n} for a running number, {nn} for a 0-prefixed running number, {pwoid} as a reference to the PWO id.
>{String}</BookmarkTitle>SortIndex
Sortable index value to reorder the content within a chapter.
>{Integer}</SortIndex>Separator
Separator page between documents added to the MRB. This is a macro and indicates an internal incremental number: {n}. Additional text can be added to better indicate end of document and start of new document.
>{String}</Separator>TemplateFilePageNumber
Reference that points to a specific page number in the Template PDF to be added to the MRB.
>{Integer}</TemplateFilePageNumber>ContentId
Identifier for section content
": "{Integer}",CreatedAt
Date and time stamp this content was created
": "{Datetime}",Type
Domain value to determine the type of content. Values are: Files, Template page
Possible domain values can be found here
": "{Integer}",Description
Description of content
": "{String}",BookmarkTitle
Title for the content page. This title supports macros like {n} for a running number, {nn} for a 0-prefixed running number, {pwoid} as a reference to the PWO id.
": "{String}",SortIndex
Sortable index value to reorder the content within a chapter.
": "{Integer}",Separator
Separator page between documents added to the MRB. This is a macro and indicates an internal incremental number: {n}. Additional text can be added to better indicate end of document and start of new document.
": "{String}",TemplateFilePageNumber
Reference that points to a specific page number in the Template PDF to be added to the MRB.
": "{Integer}"
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 107711 HTTP 400 | Cannot refer to a template page number for this type of content: Add files |
| Error 107712 HTTP 400 | Input field is not applicable for this content type: Add page from template file |
| Error 107702 HTTP 400 | Could not find MRB section id |