API

Product APIs

POST product/shared-product-subscriptions

Create shared product subscription for the provided identifier

HTTP method POST
URI https://api.rambase.net/product/shared-product-subscriptions
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 7186, version 1

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
<SharedProductSubscription>
2
     <SubscribingCompany
SubscribingCompany

Required/mandatory field

Subscribing company details. The company that is subscribing to event that takes place in shared products.

>
3
          <CompanyId
CompanyId

Required/mandatory field

Company identifier

Minimum value: 100

>{Integer}</CompanyId>
4
     </SubscribingCompany>
5
</SharedProductSubscription>
1
{
2
     "sharedProductSubscription": {
3
          "subscribingCompany
SubscribingCompany

Required/mandatory field

Subscribing company details. The company that is subscribing to event that takes place in shared products.

": {
4
               "companyId
CompanyId

Required/mandatory field

Company identifier

Minimum value: 100

": "{Integer}"
5
          }
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.
$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.

Format:
1
<SharedProductSubscription>
2
     <SharedProductSubscriptionId
SharedProductSubscriptionId

Shared product subscription identifier

>{Integer}</SharedProductSubscriptionId>
3
     <Status
Status

Status of the shared product subscription

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
6
     <SubscribingCompany
SubscribingCompany

Subscribing company details. The company that is subscribing to event that takes place in shared products.

>
7
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
8
          <Name
Name

Name of company

>{String}</Name>
9
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
10
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
11
     </SubscribingCompany>
12
</SharedProductSubscription>
1
{
2
     "sharedProductSubscription": {
3
          "sharedProductSubscriptionId
SharedProductSubscriptionId

Shared product subscription identifier

": "{Integer}",
4
          "status
Status

Status of the shared product subscription

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
7
          "subscribingCompany
SubscribingCompany

Subscribing company details. The company that is subscribing to event that takes place in shared products.

": {
8
               "companyId
CompanyId

Company identifier

": "{Integer}",
9
               "name
Name

Name of company

": "{String}",
10
               "database
Database

Abbreviation/code to identify the company

": "{String}",
11
               "companyLink
CompanyLink

Company reference

": "{String}"
12
          }
13
     }
14
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 110212 HTTP 400 Subscription company is required