GET api/v1/LockGroups

Gets all LockGroups available for user

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of LockGroup

Name	Description	Type	Additional information
AdapterVersion	Adapter version which user has set in the lockgroup settings.	enuAdapterVersion	None.
Address	Street address/city where the lockgroup is in use	string	None.
Classification		string	None.
ContactPerson	Contact person's name	string	None.
CountryCode	Lockgroup's country code. For example "FIN" for Finnish.	string	None.
Customer_ID	Customer ID who owns the lockgroup	globally unique identifier	None.
Description	Description	string	None.
ExpireDateUTC	Date when lockgroup expires. Null if doesn't expire.	date (nullable)	None.
FrontImage	User set image which is displayed on the start page of S10 Manager. Null if not set.	Collection of byte	None.
InfoText	General user written info text.	string	None.
LockGroup_ID	ID	globally unique identifier	None.
Name	Name of the lockgroup	string	None.
OptionMask	Option mask of the settings in use in the lockgroup.	enuLockGroupOptions	None.
ProgrammingAdmin	Name of the person who is responsible for programming tasks	string	None.
State	Is lockgroup in use or not	pniLockGroupState	None.
TimeZoneStandardName	Name of the time zone the lockgroup uses. For example 'FLE Standard Time'	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AdapterVersion": 1,
    "Address": "sample string 2",
    "Classification": "sample string 3",
    "ContactPerson": "sample string 4",
    "CountryCode": "sample string 5",
    "Customer_ID": "437d6e8d-6a1d-43a2-8fb7-ae157d49741c",
    "Description": "sample string 7",
    "ExpireDateUTC": "2025-10-30T06:09:43.67957+02:00",
    "FrontImage": "QEA=",
    "InfoText": "sample string 8",
    "LockGroup_ID": "bd4dfb05-aeb5-4b8e-ba7f-51f8c018840a",
    "Name": "sample string 10",
    "OptionMask": 11,
    "ProgrammingAdmin": "sample string 12",
    "State": 13,
    "TimeZoneStandardName": "sample string 14"
  },
  {
    "AdapterVersion": 1,
    "Address": "sample string 2",
    "Classification": "sample string 3",
    "ContactPerson": "sample string 4",
    "CountryCode": "sample string 5",
    "Customer_ID": "437d6e8d-6a1d-43a2-8fb7-ae157d49741c",
    "Description": "sample string 7",
    "ExpireDateUTC": "2025-10-30T06:09:43.67957+02:00",
    "FrontImage": "QEA=",
    "InfoText": "sample string 8",
    "LockGroup_ID": "bd4dfb05-aeb5-4b8e-ba7f-51f8c018840a",
    "Name": "sample string 10",
    "OptionMask": 11,
    "ProgrammingAdmin": "sample string 12",
    "State": 13,
    "TimeZoneStandardName": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLockGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
  <LockGroup>
    <AdapterVersion>1</AdapterVersion>
    <Address>sample string 2</Address>
    <Classification>sample string 3</Classification>
    <ContactPerson>sample string 4</ContactPerson>
    <CountryCode>sample string 5</CountryCode>
    <Customer_ID>437d6e8d-6a1d-43a2-8fb7-ae157d49741c</Customer_ID>
    <Description>sample string 7</Description>
    <ExpireDateUTC>2025-10-30T06:09:43.67957+02:00</ExpireDateUTC>
    <FrontImage>QEA=</FrontImage>
    <InfoText>sample string 8</InfoText>
    <LockGroup_ID>bd4dfb05-aeb5-4b8e-ba7f-51f8c018840a</LockGroup_ID>
    <Name>sample string 10</Name>
    <OptionMask>11</OptionMask>
    <ProgrammingAdmin>sample string 12</ProgrammingAdmin>
    <State>13</State>
    <TimeZoneStandardName>sample string 14</TimeZoneStandardName>
  </LockGroup>
  <LockGroup>
    <AdapterVersion>1</AdapterVersion>
    <Address>sample string 2</Address>
    <Classification>sample string 3</Classification>
    <ContactPerson>sample string 4</ContactPerson>
    <CountryCode>sample string 5</CountryCode>
    <Customer_ID>437d6e8d-6a1d-43a2-8fb7-ae157d49741c</Customer_ID>
    <Description>sample string 7</Description>
    <ExpireDateUTC>2025-10-30T06:09:43.67957+02:00</ExpireDateUTC>
    <FrontImage>QEA=</FrontImage>
    <InfoText>sample string 8</InfoText>
    <LockGroup_ID>bd4dfb05-aeb5-4b8e-ba7f-51f8c018840a</LockGroup_ID>
    <Name>sample string 10</Name>
    <OptionMask>11</OptionMask>
    <ProgrammingAdmin>sample string 12</ProgrammingAdmin>
    <State>13</State>
    <TimeZoneStandardName>sample string 14</TimeZoneStandardName>
  </LockGroup>
</ArrayOfLockGroup>