API

System APIs

PUT system/extensions/{extensionId}

Update details of an extension

HTTP method PUT
URI https://api.rambase.net/system/extensions/{extensionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {extensionId} Extension identifier
Integer, minimum 100000
Successful HTTP status code 202
API resource identifier 3822, version 6

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

This field is optional.

>
2
     <Name
Name

Extension name

This field is optional.

>{String}</Name>
3
     <Description
Description

Extension description

This field is optional.

>{String}</Description>
4
     <TermsAndConditions
TermsAndConditions

Terms and condition for using the extension

This field is optional.

>{String}</TermsAndConditions>
5
     <MainImage
MainImage

This field is optional.

>
6
          <MediumId
MediumId

Identifier of media

Minimum value: 1

This field is optional.

>{Integer}</MediumId>
7
     </MainImage>
8
     <Publisher
Publisher

This field is optional.

>
9
          <PublisherId
PublisherId

Publisher identifier

Minimum value: 100000

This field is optional.

>{Integer}</PublisherId>
10
     </Publisher>
11
</Extension>
1
{
2
     "extension
Extension

This field is optional.

": {
3
          "name
Name

Extension name

This field is optional.

": "{String}",
4
          "description
Description

Extension description

This field is optional.

": "{String}",
5
          "termsAndConditions
TermsAndConditions

Terms and condition for using the extension

This field is optional.

": "{String}",
6
          "mainImage
MainImage

This field is optional.

": {
7
               "mediumId
MediumId

Identifier of media

Minimum value: 1

This field is optional.

": "{Integer}"
8
          },
9
          "publisher
Publisher

This field is optional.

": {
10
               "publisherId
PublisherId

Publisher identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
11
          }
12
     }
13
}

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 104746 HTTP 404 Publisher not found
Error 104840 HTTP 400 Description is required
Error 104841 HTTP 400 Publisher is required
Error 105043 HTTP 400 Extension cover image is required
Error 105044 HTTP 400 Terms and condition are required