API

Production APIs

PUT production/mrb-specifications/{mrbSpecificationId}/sections/{sectionId}

Updates details in a MRB specification section

HTTP method PUT
URI https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}/sections/{sectionId}
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 200
API resource identifier 5559, version 2

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
<Section
Section

This field is optional.

>
2
     <Title
Title

Chapter title. This will show as a bookmark in the book.

This field is optional.

>
{String}</Title>
3
     <SortIndex
SortIndex

Sortable index to shift chapter order.

Minimum value: 1

This field is optional.

>
{Integer}</SortIndex>
4
     <EmptyStrategy
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

This field is optional.

>
{Integer}</EmptyStrategy>
5
     <ParentSection
ParentSection

Parent chapter item to build a treeview model of the book

This field is optional.

>
6
          <ParentSectionId
ParentSectionId

Book section identifier

Minimum value: 1

This field is optional.

>
{Integer}</ParentSectionId>
7
     </ParentSection>
8
</Section>
1
{
2
     "section
Section

This field is optional.

":
{
3
          "title
Title

Chapter title. This will show as a bookmark in the book.

This field is optional.

":
"{String}",
4
          "sortIndex
SortIndex

Sortable index to shift chapter order.

Minimum value: 1

This field is optional.

":
"{Integer}",
5
          "emptyStrategy
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

This field is optional.

":
"{Integer}",
6
          "parentSection
ParentSection

Parent chapter item to build a treeview model of the book

This field is optional.

":
{
7
               "parentSectionId
ParentSectionId

Book section identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
8
          }
9
     }
10
}

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.

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
1

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