Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/User/Subgroups?userid={USERID}

Get all subgroups that the user is allowed and has selected to view

Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/User/Subgroups?userid={USERID}

HTTP Method: GET

Message direction Format Body
Request N/A The Request body is empty.
Response Xml Example,Schema
Response Json Example

The following is an example response Xml body:

<ArrayOfDCUserSubGroup xmlns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts">
  <DCUserSubGroup>
    <ID>2147483647</ID>
    <OfficeUserID>2147483647</OfficeUserID>
    <Selected>2147483647</Selected>
    <Subgroup>
      <ID>2147483647</ID>
      <MobileGroupID>2147483647</MobileGroupID>
      <SubGroupName>String content</SubGroupName>
      <TimeZoneCode>2147483647</TimeZoneCode>
    </Subgroup>
  </DCUserSubGroup>
  <DCUserSubGroup>
    <ID>2147483647</ID>
    <OfficeUserID>2147483647</OfficeUserID>
    <Selected>2147483647</Selected>
    <Subgroup>
      <ID>2147483647</ID>
      <MobileGroupID>2147483647</MobileGroupID>
      <SubGroupName>String content</SubGroupName>
      <TimeZoneCode>2147483647</TimeZoneCode>
    </Subgroup>
  </DCUserSubGroup>
</ArrayOfDCUserSubGroup>

The following is an example response Json body:

[{
	"ID":2147483647,
	"OfficeUserID":2147483647,
	"Selected":2147483647,
	"Subgroup":{
		"ID":2147483647,
		"MobileGroupID":2147483647,
		"SubGroupName":"String content",
		"TimeZoneCode":2147483647
	}
}]

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ArrayOfDCUserSubGroup">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="DCUserSubGroup" nillable="true" type="tns:DCUserSubGroup" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfDCUserSubGroup" nillable="true" type="tns:ArrayOfDCUserSubGroup" />
  <xs:complexType name="DCUserSubGroup">
    <xs:sequence>
      <xs:element minOccurs="0" name="ID" type="xs:int" />
      <xs:element minOccurs="0" name="OfficeUserID" type="xs:int" />
      <xs:element minOccurs="0" name="Selected" type="xs:int" />
      <xs:element minOccurs="0" name="Subgroup" nillable="true" type="tns:DCSubGroup" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="DCUserSubGroup" nillable="true" type="tns:DCUserSubGroup" />
  <xs:complexType name="DCSubGroup">
    <xs:sequence>
      <xs:element minOccurs="0" name="ID" type="xs:int" />
      <xs:element minOccurs="0" name="MobileGroupID" type="xs:int" />
      <xs:element minOccurs="0" name="SubGroupName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TimeZoneCode" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="DCSubGroup" nillable="true" type="tns:DCSubGroup" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
  <tns:element name="schema">
    <tns:complexType />
  </tns:element>
</tns:schema>