Similar to “retrieve all packs”, this method only lists the packs and not all of the sub components attached or configured within them. For example, it will provide the Company ID, Company Name, Pack Name and Pack ID only.
The {options} allow you to refine the results retrieved from the API. They must be formatted as a query string, e.g. if you use more than one, the 2nd one onwards should be preceded by an ampersand “&” character. The options include:
| Parameter | Description |
|
perpage={perpage}
|
An integer for number of items you would like returned in this response E.g. {20} |
| pageno={page} | An integer for the page number (only applicable if the perpage is used) E.g. {1} |
| sortField={sortField} | The field you wish to sort by |
| sortOrder={sortOrder} | The sort direction. E.g. {asc} or {desc} |
| searchField={searchField} | The field you wish to search for |
| searchOper={searchOper} | E.g. {contains}, {equal}, {not equal}, {begins with} or {ends with} Used when a search field is specified |
| searchString={searchString} | The value you wish to search for |
| CompanyId={CompanyId} | The ID of the company you wish to retrieve pacs for, or leave blank for a list of all pacs for all companies |
| publishedStatus={publishedStatus} | [null], All, ipv4, ipv6 – a blank or null value will provide all pacs, published and unpublished. All, ipv4 and ipv6 will only provide published pacs of the desired type |