---
title: "Collections"
canonical: "https://support.soutron.net/space/LMSAPI/2228328/Collections"
format: markdown
---
## <span style="color: #008000">GET </span><span style="color: #008000">/catalogues/collections</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get list of available collections.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| <span style="color: #000000">privateOnly</span> | privateOnly=true | Return only collections which are private. False returns all available collections based on access permission. Accepted values are:True(1) or False(0) |
| <span style="color: #000000">hasCIDs</span> | <span style="color: #000000">hasCIDs=386568,386567,386566</span><br><span style="color: #000000">hasCIDs=386568&hasCIDs=386567&hasCIDs=386566</span> | <span style="color: #000000">Return only collections where records exist. CID's can be passed individually or as a comma separated string.</span> |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #000000">/SoutronAPI/catalogues/collections</span>

<details>
<summary>Response</summary>

```xml
<CollectionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Catalogues">
	<Collections>
		<CollectionListItem>
			<CollectionId>17</CollectionId>
			<Description i:nil="true"/>
			<Name>Hydro Power </Name>
		</CollectionListItem>
		<CollectionListItem>
			<CollectionId>20</CollectionId>
			<Description i:nil="true"/>
			<Name>gp</Name>
		</CollectionListItem>
		<CollectionListItem>
			<CollectionId>21</CollectionId>
			<Description i:nil="true"/>
			<Name>test2</Name>
		</CollectionListItem>
	</Collections>
</CollectionListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/catalogues/collections/{CollectionID}</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get Catalogue records for selected Collection.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| <span style="color: #000000">CollectionID</span><br>[Required] | <span style="color: #000000">CollectionID</span>=18 | Return records for selected collection. |
| <span style="color: #003366">read-content-type</span> | <span style="color: #003366">read-content-type=Printed Material</span> | <span style="color: #003366">Content type identifier or caption to read records from.</span> |
| <span style="color: #ff0000">content-record-type</span> | <span style="color: #ff0000">content-record-type=Printed Material:Books</span> | <span style="color: #ff0000">Content/record type pairs to filter search result, use name or ID. check multiple pairs</span> |
| <span style="color: #000000">sorting</span> | - <span style="color: #003366">sorting=Title:Ascending</span>
- <span style="color: #003366">sorting=Title:0:WithNoiseWords</span>
- <span style="color: #003366">sort=Title:Ascending:WithNoiseWords;Publication Date:Descending;24:Ascending</span> | <span style="color: #003366">By default the search result template sorting rules applied. Sort field can be by name or ID.</span><br><span style="color: #003366">Sort direction uses </span>**<span style="color: #003366">Ascending</span>**<span style="color: #003366"> (</span>**<span style="color: #003366">0</span>**<span style="color: #003366">) or </span>**<span style="color: #003366">Descending</span>**<span style="color: #003366"> (</span>**<span style="color: #003366">1</span>**<span style="color: #003366">) when added after field name. Ascending is the default.</span><br><span style="color: #003366">To sort without noise words (a,the..) being used add :</span>**<span style="color: #003366">WithNoiseWords</span>**<span style="color: #003366"> (</span>**<span style="color: #003366">0</span>**<span style="color: #003366">) after sort direction. Or  :</span>**<span style="color: #003366">WithoutNoiseWords</span>**<span style="color: #003366"> (</span>**<span style="color: #003366">1</span>**<span style="color: #003366">) to include noise words in the sort order. WithNoiseWords is the default.</span><br><span style="color: #003366">Sorting by multiple fields can be done separating each sort using semi-colon ( ; ).</span> |
| <span style="color: #003366">result-view</span> | <span style="color: #000000">result-view=</span><span style="color: #003366">Citation </span> | <span style="color: #333333">Search result view name to use to get list of fields to be returned. </span><span style="color: #003366">Citation (or 1), Thumbnail (or 2), GridView (or 3)</span><br>Highest priority is an exact match for Portal, app mode (definition is if user is a guest, logged in user or administrator) and content type, if not all three are matched then the below priority order is used.<br>1. Match by app mode, portal. Content Type = NULL
2. Match by app mode, portal = NULL, Content Type match
3. Match by app mode, portal = null, ct = null
4. App mode = null, portal match, CT match
5. App mode = null, portal match, CT = null
6. app mode = null, portal null, CT match
7. app mode = null, portal null, CT = null<br>Result Groups are not included in API result-view, it is expected that these can be generated manually via the API if required. |
| <span style="color: #000000">page</span> | page=2 | <span style="color: #333333"> S</span><span style="color: #333333">earch result page number to return records from. First page number is 1. </span> |
| <span style="color: #000000">page-size</span> | <span style="color: #000000">page-size=100</span> | <span style="color: #333333">Amount of records to return per each page.</span> |
| <span style="color: #000000">lang</span> | lang=2057 | <span style="color: #333333">Language name or LCID code to use to search records and return language dependent data in the data records.</span> |
| <span style="color: #000000">read-fields</span> | <span style="color: #000000">read-fields=Title,11,Authors</span> | <span style="color: #333333">Comma separated list of fields to return in the search result. The field can be it's caption or unique identifier.</span> |
| <span style="color: #000000">office</span> | office=1 | Office name or ID to use for search data (affects search permission) |
| <span style="color: #000000">portal</span> | portal=1 | Portal name or ID to use for search data (affects search permission) |
| <span style="color: #000000">name-standard</span> | <span style="color: #000000">name-standard=ris</span> | <span style="color: #333333">Field captions naming standard to use</span> |
| <span style="color: #000000">xmlType</span> | <span style="color: #000000">xmlType=1</span> | <span style="color: #333333">The way of XML response format. Supported values are AttributeBase (0) or ElementBase (1). The default is attribute based.</span> |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #003366">/SoutronAPI/catalogues/collections/18?read-content-type=1&content-record-type=1&sort=Title&result-view=citation&page=1&page-size=5&lang=2057&read-fields=Title&office=1&portal=1</span>

<details>
<summary>Response</summary>

```xml
<response searchTime="3" sortTime="3" requestTime="150.5412">
	<resultInfo searchId="0">
		<contentTypes>
			<contentType caption="All" count="7" seq="0"/>
			<contentType id="3" caption="Serial" count="6" seq="1"/>
			<contentType id="1" caption="Printed Material" count="1" seq="2" current="1"/>
		</contentTypes>
		<recordTypes>
			<recordType id="1" caption="Books" count="4"/>
			<recordType id="6" caption="Serial" count="3"/>
		</recordTypes>
	</resultInfo>
	<records>
		<record id="405380" type="10" subType="1" rt="1" rtCaption="Books" ct="1" ctCaption="Printed Material" deleted="0" published="1">
			<fs>
				<f id="138" type="3" caption="Simple Date">
					<vs>
						<v id="403161" seq="1" custom="0" startYear="2019" startMonth="3" startDay="5" startTime="10815" endYear="2019" endMonth="3" endDay="27" endTime="0" circa="0" ongoing="0" noDate="0"/>
					</vs>
				</f>
				<f id="9" type="1" caption="Title">
					<vs>
						<v id="2561283" seq="1" custom="0">test123</v>
					</vs>
				</f>
				<f id="14" type="5" caption="Authors">
					<vs>
						<v id="2320866" seq="1" custom="1" value="80575">A S Balasubramaniam</v>
					</vs>
				</f>
			</fs>
		</record>
	</records>
</response>
```
</details>