API

System APIs

POST system/extensions/{extensionId}/media

Create new media

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

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
<Medium>
2
     <Base64EncodedImage
Base64EncodedImage

Required/mandatory field

Base64 endoded PNG- or JPG-image

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

Description of media. Typically used in html img alt-attribute.

This field is optional.

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

Priority of media used in listing

This field is optional.

>{Integer}</Priority>
5
</Medium>
1
{
2
     "medium": {
3
          "base64EncodedImage
Base64EncodedImage

Required/mandatory field

Base64 endoded PNG- or JPG-image

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

Description of media. Typically used in html img alt-attribute.

This field is optional.

": "{String}",
5
          "priority
Priority

Priority of media used in listing

This field is optional.

": "{Integer}"
6
     }
7
}

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.
$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.

Format:
1
<Medium>
2
     <MediumId
MediumId

Identifier of media

>{Integer}</MediumId>
3
     <Url
Url

Url to media

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

Description of media. Typically used in html img alt-attribute.

>{String}</Description>
5
     <Priority
Priority

Priority of media used in listing

>{Integer}</Priority>
6
</Medium>
1
{
2
     "medium": {
3
          "mediumId
MediumId

Identifier of media

": "{Integer}",
4
          "url
Url

Url to media

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

Description of media. Typically used in html img alt-attribute.

": "{String}",
6
          "priority
Priority

Priority of media used in listing

": "{Integer}"
7
     }
8
}

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: