API Docs

__METHOD= GET . __PATH= /almaws/v1/conf/sets .

Retrieve a list of Sets

This Web service returns a list of Sets.

Resource URL

GET /almaws/v1/conf/sets

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
content_typexs:stringOptional.Content type for filtering. Optional. Valid values are from the SetContentType code table
set_typexs:stringOptional.Set type for filtering. Optional. Valid values are 'ITEMIZED' or 'LOGICAL'.
qxs:stringOptional.Search query. Optional. Searching for words in created_by or name (see Brief Search)
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.

Body Parameters

None

Output

This method returns a Sets object. See doc

Possible Error Codes

CodeMessage
40166410Parameter value invalid.
60106Invalid query format.
60107Invalid set ID.