GET Utility/GetRestrictedGroups

Returns the list of restricted groups from the API setup

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Returns the list of restricted groups from the API setup

Name	Description	Type
Status	0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful	string
Message	Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know	string
Count	Number of results returned	string
Data	List of properties and values returned for each restricted group that matches the request	Collection of RestrictedGroup

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "Data": [
    {
      "Key": 1,
      "Name": "sample string 2"
    },
    {
      "Key": 1,
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvUtilityRestrictedGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Utility">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.API">
    <d2p1:ClsApi.RestrictedGroup>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ClsApi.RestrictedGroup>
    <d2p1:ClsApi.RestrictedGroup>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ClsApi.RestrictedGroup>
  </Data>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvUtilityRestrictedGroup>