Production APIs
Create new sections in the MRB specification
| HTTP method | POST |
| URI | https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}/sections |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {mrbSpecificationId} |
MRB specification identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 5558, 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.
Title
Required/mandatory field
Chapter title. This will show as a bookmark in the book.
>{String}</Title>EmptyStrategy
Domain value to set what happens to an empty chapter. Values are: None, remove bookmark if chapter is empty, Add NA to the chapter or content bookmark if chapter is empty.
Applicable domain values can be found here
Default value: 0
This field is optional.
>{Integer}</EmptyStrategy>ParentSection
Parent chapter item to build a treeview model of the book
This field is optional.
>ParentSectionId
Book section identifier
Minimum value: 1
This field is optional.
>{Integer}</ParentSectionId>Title
Required/mandatory field
Chapter title. This will show as a bookmark in the book.
": "{String}",EmptyStrategy
Domain value to set what happens to an empty chapter. Values are: None, remove bookmark if chapter is empty, Add NA to the chapter or content bookmark if chapter is empty.
Applicable domain values can be found here
Default value: 0
This field is optional.
": "{Integer}",ParentSection
Parent chapter item to build a treeview model of the book
This field is optional.
": {ParentSectionId
Book section identifier
Minimum value: 1
This field is optional.
": "{Integer}"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.
SectionId
Book section identifier
>{Integer}</SectionId>Title
Chapter title. This will show as a bookmark in the book.
>{String}</Title>TranslatedTitle
Translated section title
>{String}</TranslatedTitle>SortIndex
Sortable index to shift chapter order.
>{Integer}</SortIndex>CreatedAt
Date and time stamp for the creeation of the section.
>{Datetime}</CreatedAt>HasChildren
Flag to be used for applications to correctly display the expandable tree node for a section
>{Boolean}</HasChildren>EmptyStrategy
Domain value to set what happens to an empty chapter. Values are: None, remove bookmark if chapter is empty, Add NA to the chapter or content bookmark if chapter is empty.
Possible domain values can be found here
>{Integer}</EmptyStrategy>ParentSection
Parent chapter item to build a treeview model of the book
>ParentSectionId
Book section identifier
>{Integer}</ParentSectionId>ParentSectionLink
Full id reference to a book section.
>{String}</ParentSectionLink>SectionId
Book section identifier
": "{Integer}",Title
Chapter title. This will show as a bookmark in the book.
": "{String}",TranslatedTitle
Translated section title
": "{String}",SortIndex
Sortable index to shift chapter order.
": "{Integer}",CreatedAt
Date and time stamp for the creeation of the section.
": "{Datetime}",HasChildren
Flag to be used for applications to correctly display the expandable tree node for a section
": "{Boolean}",EmptyStrategy
Domain value to set what happens to an empty chapter. Values are: None, remove bookmark if chapter is empty, Add NA to the chapter or content bookmark if chapter is empty.
Possible domain values can be found here
": "{Integer}",ParentSection
Parent chapter item to build a treeview model of the book
": {ParentSectionId
Book section identifier
": "{Integer}",ParentSectionLink
Full id reference to a book section.
": "{String}"
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 107701 HTTP 400 | MRB specification is not found |
| Error 107702 HTTP 400 | Could not find MRB section id |