API Docs
Retrieve vendors
Contents
This API returns a list of Vendors.
Resource URL
GET /almaws/v1/acq/vendors
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | xs:string | Optional. Default: ALL | Vendor Status. Optional. Valid values: active, inactive |
type | xs:string | Optional. Default: ALL | Vendor Type. Optional. Valid values: material_supplier, access_provider, licensor, governmental. |
q | xs:string | Optional. | 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) |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset 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
| Code | Message |
|---|---|
| 402119 | General error. |