API

Procurement APIs

POST procurement/purchase-groups/{purchaseGroupId}/members

Adds member to provided purchase group

HTTP method POST
URI https://api.rambase.net/procurement/purchase-groups/{purchaseGroupId}/members
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseGroupId} Purchase group identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3518, 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
<Member>
2
     <Employee>
3
          <EmployeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

>{Integer}</EmployeeId>
4
     </Employee>
5
</Member>
1
{
2
     "member": {
3
          "employee": {
4
               "employeeId
EmployeeId

Required/mandatory field

Employee 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
<Member>
2
     <MemberId
MemberId

Member identifier

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

Purchase group membership status

Possible domain values can be found here

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

Date and time of creation

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

Date and time when purchase group membership was deactivated

>{Datetime}</RemovedAt>
6
     <Employee>
7
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
8
          <LastName
LastName

Last name of employee

>{String}</LastName>
9
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
10
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
11
     </Employee>
12
     <AddedBy>
13
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Member identifier

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

Purchase group membership status

Possible domain values can be found here

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

Date and time of creation

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

Date and time when purchase group membership was deactivated

": "{Datetime}",
7
          "employee": {
8
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
9
               "lastName
LastName

Last name of employee

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

First name of employee

": "{String}",
11
               "employeeLink
EmployeeLink

Employee reference

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

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
24
          }
25
     }
26
}

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 101814 HTTP 404 Employee not found
Error 104369 HTTP 400 This employee is already member of this group