---
title: "Offices & Libraries"
canonical: "https://support.soutron.net/space/LMSAPI/2228442/Offices%20%26%20Libraries"
format: markdown
---
## <span style="color: #008000">GET </span><span style="color: #008000">/offices</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get a list of all offices with library information.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Active | <span style="color: #172b4d">Active=true</span> | Get only active offices using True/False (1/0) |
| Physical | `physical=true` | Get only physical libraries using True (1), not setting or setting to false(0) will return all libraries. |
| Officeid | officeid=2 | Get details for a specific office. |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #000000">/SoutronAPI/offices?Active=true&Physical=true&OfficeId=2</span>

<details>
<summary>Response</summary>

```xml
<OfficeListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Offices>
		<OfficeItem>
			<Active>true</Active>
			<CountryIsoCode>GB </CountryIsoCode>
			<CountryName>United Kingdom</CountryName>
			<CurrencyIsoCode>GBP</CurrencyIsoCode>
			<CurrencyNameInEng>United Kingdom, Pounds</CurrencyNameInEng>
			<Default>false</Default>
			<DefaultLangCode>EN</DefaultLangCode>
			<DefaultLangNameInEng>English (United Kingdom)</DefaultLangNameInEng>
			<DefaultLibraryId>9</DefaultLibraryId>
			<DefaultLibraryName>DubLib</DefaultLibraryName>
			<GroupId>2</GroupId>
			<GroupName>test</GroupName>
			<Libraries>
				<LibraryItem>
					<Active>true</Active>
					<Code>DubLib</Code>
					<Description i:nil="true"/>
					<Email i:nil="true"/>
					<LibraryId>9</LibraryId>
					<Name>DubLib</Name>
					<OfficeId>2</OfficeId>
					<ParentLibraryId i:nil="true"/>
					<RoomNumber i:nil="true"/>
					<ShortName>DubLib</ShortName>
					<Virtual>false</Virtual>
				</LibraryItem>
			</Libraries>
			<Name>Dublin</Name>
			<OfficeId>2</OfficeId>
			<ShortCode>Dub </ShortCode>
		</OfficeItem>
	</Offices>
</OfficeListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/offices/{officeid}</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get language details for specified officeId.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| officeid<br>[Required] | <span style="color: #000000">/SoutronAPI/offices/2</span> | Get details for a specific office. |

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

<details>
<summary>Response</summary>

```xml
<OfficeListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Offices>
		<OfficeItem>
			<Active>true</Active>
			<CountryIsoCode>GB </CountryIsoCode>
			<CountryName>United Kingdom</CountryName>
			<CurrencyIsoCode>GBP</CurrencyIsoCode>
			<CurrencyNameInEng>United Kingdom, Pounds</CurrencyNameInEng>
			<Default>false</Default>
			<DefaultLangCode>EN</DefaultLangCode>
			<DefaultLangNameInEng>English (United Kingdom)</DefaultLangNameInEng>
			<DefaultLibraryId>9</DefaultLibraryId>
			<DefaultLibraryName>DubLib</DefaultLibraryName>
			<GroupId>2</GroupId>
			<GroupName>test</GroupName>
			<Libraries>
				<LibraryItem>
					<Active>true</Active>
					<Code>DubLib</Code>
					<Description i:nil="true"/>
					<Email i:nil="true"/>
					<LibraryId>9</LibraryId>
					<Name>DubLib</Name>
					<OfficeId>2</OfficeId>
					<ParentLibraryId i:nil="true"/>
					<RoomNumber i:nil="true"/>
					<ShortName>DubLib</ShortName>
					<Virtual>false</Virtual>
				</LibraryItem>
			</Libraries>
			<Name>Dublin</Name>
			<OfficeId>2</OfficeId>
			<ShortCode>Dub </ShortCode>
		</OfficeItem>
	</Offices>
</OfficeListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/offices/{officeid}/libraries</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get a list of all libraries for a specified office.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Active | <span style="color: #172b4d">Active=true</span> | Get only active offices using True/False (1/0) |
| Physical | `physical=true` | Get only physical libraries using True (1), not setting or setting to false(0) will return all libraries. |
| Officeid<br>[Required] | officeid=2 | Get details for a specific office. |
| Libraryid | libraryid=1 | Get details for specific library within office |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #000000">/SoutronAPI/offices/1/libraries?Active=true&Physical=true&LibraryId=1</span>

<details>
<summary>Response</summary>

```xml
<LibraryListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Libraries>
		<LibraryItem>
			<Active>true</Active>
			<Code>LIB</Code>
			<Description i:nil="true"/>
			<Email>soutronadmin@soutron.com</Email>
			<LibraryId>1</LibraryId>
			<Name>Library</Name>
			<OfficeId>1</OfficeId>
			<ParentLibraryId i:nil="true"/>
			<RoomNumber i:nil="true"/>
			<ShortName i:nil="true"/>
			<Virtual>false</Virtual>
		</LibraryItem>
	</Libraries>
</LibraryListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/offices/{officeid}/libraries/{librariesid}</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get a list of all libraries for a specified office.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Officeid<br>[Required] | <span style="color: #000000">/SoutronAPI/offices/</span><span style="color: #ff0000">1</span><span style="color: #000000">/libraries/1</span> | Get details for a specific office. |
| Libraryid<br>[Required] | <span style="color: #000000">/SoutronAPI/offices/1/libraries/</span><span style="color: #ff0000">1</span> | Get details for specific library within office |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #000000">/SoutronAPI/offices/1/libraries/1</span>

<details>
<summary>Response</summary>

```xml
<LibraryListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Libraries>
		<LibraryItem>
			<Active>true</Active>
			<Code>LIB</Code>
			<Description i:nil="true"/>
			<Email>soutronadmin@soutron.com</Email>
			<LibraryId>1</LibraryId>
			<Name>Library</Name>
			<OfficeId>1</OfficeId>
			<ParentLibraryId i:nil="true"/>
			<RoomNumber i:nil="true"/>
			<ShortName i:nil="true"/>
			<Virtual>false</Virtual>
		</LibraryItem>
	</Libraries>
</LibraryListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/libraries</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get a list of all libraries.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Active | <span style="color: #172b4d">Active=true</span> | Get only active offices using True/False (1/0) |
| Physical | `physical=true` | Get only physical libraries using True (1), not setting or setting to false(0) will return all libraries. |
| Officeid | officeid=2 | Get details for a specific office. |
| Libraryid | libraryid=1 | Get details for specific library |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #000000">/SoutronAPI/libraries?Active=true&Physical=true&OfficeId=1&LibraryId=1</span>

<details>
<summary>Response</summary>

```xml
<LibraryListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Libraries>
		<LibraryItem>
			<Active>true</Active>
			<Code>LIB</Code>
			<Description i:nil="true"/>
			<Email>soutronadmin@soutron.com</Email>
			<LibraryId>1</LibraryId>
			<Name>Library</Name>
			<OfficeId>1</OfficeId>
			<ParentLibraryId i:nil="true"/>
			<RoomNumber i:nil="true"/>
			<ShortName i:nil="true"/>
			<Virtual>false</Virtual>
		</LibraryItem>
	</Libraries>
</LibraryListResponse>
```
</details>


## <span style="color: #008000">GET </span><span style="color: #008000">/libraries/{libraryid}</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get details for specified library

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Libraryid<br>[Required] | <span style="color: #000000">/SoutronAPI/libraries/1</span> | Get details for specific library |

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

<details>
<summary>Response</summary>

```xml
<LibraryListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Infrastructure">
	<Libraries>
		<LibraryItem>
			<Active>true</Active>
			<Code>LIB</Code>
			<Description i:nil="true"/>
			<Email>soutronadmin@soutron.com</Email>
			<LibraryId>1</LibraryId>
			<Name>Library</Name>
			<OfficeId>1</OfficeId>
			<ParentLibraryId i:nil="true"/>
			<RoomNumber i:nil="true"/>
			<ShortName i:nil="true"/>
			<Virtual>false</Virtual>
		</LibraryItem>
	</Libraries>
</LibraryListResponse>
```
</details>