API Docs

__METHOD= POST . __PATH= /almaws/v1/conf/sets/{set_id} .

Manage Members

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

set_idxs:stringUnique id of the set. Mandatory.

Querystring Parameters

id_typexs:stringOptional.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
opxs:stringRequiredThe operation to perform on the set. Mandatory. The supported operations are add_members, delete_members or replace_members.
fail_on_invalid_idxs:booleanOptional. Default: trueIf false, the API will ignore invalid IDs. Relevant for sets of Bibs, Items and Users.

Body Parameters

This method takes a Set object including list of members to add/remove. Up to 1000 members can be supplied. See doc


This method returns a Set object. See doc

Possible Error Codes

60107Invalid set ID.
60111Invalid operation.
60112Invalid set type.
60113Input set with no members.
60114Input set with no member ID.
60115A member ID is already in the set.
60116A member ID is not valid for the content.
60117Input set member ID is not in set.
60118Input set member list exceeds limit.
60119Input set with duplicate member.
60120A member ID is not valid for the content and identifier.
60176A member ID which is represented by an id_type identifier is already in the set.
40166410Invalid parameter identifier type.