API Docs
Manage Members
Contents
This Web service manages the operations of add, delete and replace for members of a Set given a Set ID.
Resource URL
POST /almaws/v1/conf/sets/{set_id}API Description
URL Parameters
| Parameter | Type | Description |
|---|---|---|
set_id | xs:string | Unique id of the set. Mandatory. |
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id_type | xs:string | Optional. | The type of the identifier that is used to identify members. Optional. For physical items: BARCODE. For Bib records: SYSTEM_NUMBER, OCLC_NUMBER, ISBN, ISSN. For regular MMS-IDs no need to defined this parameter. For users: any type that is defined in UserIdentifierTypes Code Table |
op | xs:string | Required | The operation to perform on the set. Mandatory. The supported operations are add_members, delete_members or replace_members. |
Body Parameters
This method takes a Set object including list of members to add/remove. Up to 1000 members can be supplied. See doc
Output
This method returns a Set object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 60107 | Invalid set ID. |
| 60111 | Invalid operation. |
| 60112 | Invalid set type. |
| 60113 | Input set with no members. |
| 60114 | Input set with no member ID. |
| 60115 | A member ID is already in the set. |
| 60116 | A member ID is not valid for the content. |
| 60117 | Input set member ID is not in set. |
| 60118 | Input set member list exceeds limit. |
| 60119 | Input set with duplicate member. |
| 60120 | A member ID is not valid for the content and identifier. |
| 60176 | A member ID which is represented by an id_type identifier is already in the set. |
| 40166410 | Invalid parameter identifier type. |