API Docs

__METHOD= GET . __PATH= /almaws/v1/acq/vendors .

Retrieve vendors

This API returns a list of Vendors.

Resource URL

GET /almaws/v1/acq/vendors

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
statusxs:stringOptional. Default: ALLVendor Status. Optional. Valid values: active, inactive
typexs:stringOptional. Default: ALLVendor Type. Optional. Valid values: material_supplier, access_provider, licensor, governmental.
qxs:stringOptional.Search query. Optional. Searching for words from: interface_name, name, code, library & all (for searching in all the above fields). Example (note the tilde between the code and text): q=name~Association (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 Vendors object. See doc

Possible Error Codes

CodeMessage
402119General error.