API

Product APIs

POST product/groups/{productGroupId}/members

Add a new member to the given product group

HTTP method POST
URI https://api.rambase.net/product/groups/{productGroupId}/members
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productGroupId} Product group identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2454, 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
<Member
Member

This field is optional.

>
2
     <Product
Product

This field is optional.

>
3
          <ProductId
ProductId

Product identifier

This field is optional.

>{Integer}</ProductId>
4
     </Product>
5
</Member>
1
{
2
     "member
Member

This field is optional.

": {
3
          "product
Product

This field is optional.

": {
4
               "productId
ProductId

Product identifier

This field is optional.

": "{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
<Member>
2
     <MemberId
MemberId

Group member identifier

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

Product group membership status

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

Date and time of creation

>{Datetime}</AddedAt>
5
     <RemovedAt
RemovedAt

Datetime when product was removed from group

>{Datetime}</RemovedAt>
6
     <Product>
7
          <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
8
          <Status
Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>
9
          <Name
Name

Name of the product

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

Description of the product

>{String}</Description>
11
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
12
     </Product>
13
     <AddedBy>
14
          <UserId
UserId

User identifier

>{Integer}</UserId>
15
          <Name
Name

Name of the user

>{String}</Name>
16
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
17
          <UserLink
UserLink

User reference

>{String}</UserLink>
18
     </AddedBy>
19
     <RemovedBy>
20
          <UserId
UserId

User identifier

>{Integer}</UserId>
21
          <Name
Name

Name of the user

>{String}</Name>
22
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
23
          <UserLink
UserLink

User reference

>{String}</UserLink>
24
     </RemovedBy>
25
</Member>
1
{
2
     "member": {
3
          "memberId
MemberId

Group member identifier

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

Product group membership status

": "{Integer}",
5
          "addedAt
AddedAt

Date and time of creation

": "{Datetime}",
6
          "removedAt
RemovedAt

Datetime when product was removed from group

": "{Datetime}",
7
          "product": {
8
               "productId
ProductId

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

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

Description of the product

": "{String}",
12
               "productLink
ProductLink

Product reference

": "{String}"
13
          },
14
          "addedBy": {
15
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
17
               "firstName
FirstName

First name of the user

": "{String}",
18
               "userLink
UserLink

User reference

": "{String}"
19
          },
20
          "removedBy": {
21
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
23
               "firstName
FirstName

First name of the user

": "{String}",
24
               "userLink
UserLink

User reference

": "{String}"
25
          }
26
     }
27
}

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 102666 HTTP 400 Product already exists in product group