API Docs
Retrieve PO-Lines
Contents
This API returns a list of PO-Lines.
Resource URL
GET /almaws/v1/acq/po-lines
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
q | xs:string | Optional. | Search query. Optional. Searching for words from: title, author, mms_id, publisher, publication_year, publication_place, issn_isbn, shelving_location, vendor_code, vendor_name, vendor_account, fund_code, fund_name, number, po_number, invoice_reference & all (for searching in all the above fields). It is also possible to search on fields from the related items (relevant for libraries who have one PO-Line per Item, and the maximum number of records which can be retrieved is limited): enumeration_a/b/c, chronology_i/j/k, item_description and item_library. Example (note the tilde between the code and text): q=author~Mark (see Brief Search) |
status | xs:string | Optional. Default: ALL | PO-Line Status. Optional. Valid values are CLOSED, CANCELLED, ACTIVE, ALL, ALL_WITH_CLOSED. Default: ALL (retrieves all PO lines except CLOSED). |
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. |
order_by | xs:string | Optional. Default: title | Order by parameter. Optional. The default is title. The Order by options are number, title, created_date and po_number. It is also possible to sort by fields from the related items (relevant for libraries who have one PO-Line per Item, and only works when the search query included item related fields): enumeration_a/b/c, chronology_i/j/k & item_description. The secondary sort is on number. |
direction | xs:string | Optional. Default: desc | Direction of ordering. Optional. The choices are asc, desc. The default is desc. |
acquisition_method | xs:string | Optional. Default: ALL | Filter by acquisition method, e.g. PURCHASE. Optional. The default is to do no filtering. |
expand | xs:string | Optional. | The expand parameter allows for increasing the PO-Lines information with data on: notes - The PO notes. locations - The PO locations with their sub objects. To get more than one, use a comma separator. Optional. |
library | xs:string | Optional. | The code of the library that owns the PO lines. Optional. If supplied, only the PO Lines for this library will be retrieved. If not supplied, all the PO Lines that match the other parameters will be retrieved. |
min_expected_arrival_date | xs:string | Optional. | Retrieve PO lines with expected arrival date starting this Date (YYYY-MM-DD). Optional. |
max_expected_arrival_date | xs:string | Optional. | Retrieve PO lines with expected arrival date until this Date (YYYY-MM-DD), included. Optional. |
Body Parameters
None
Output
This method returns a PO-Lines object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 402119 | General error. |
| 40188600 | Search query parameter X is not supported. |
| 40188602 | Results cannot be sorted by item attribute without providing at least one condition for item search. |
| 40188603 | Results can be sorted by one or more item attributes OR one Poline attribute. |
| 40188604 | order_by value X is invalid. Valid sort values are: [list of valid sort values]. |
| 40188605 | The provided search query returns more than X items. Please narrow your search. |