GET {clientId}/GroupNames?Id={Id}

This method will retrieve all Group Names.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required
Id	Optional Type Id. If specified, only the Type with this Id will be returned.	integer	Default value is 0

Body Parameters

None.

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

GroupTypeNameEntryList

Name	Description	Type	Additional information
GroupTypeNames		Collection of GroupTypeNameEntry

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "GroupTypeNames": [
    {
      "TypeID": 1,
      "GroupType": "sample string 2",
      "GroupNames": [
        {
          "Name": "sample string 1"
        },
        {
          "Name": "sample string 1"
        }
      ]
    },
    {
      "TypeID": 1,
      "GroupType": "sample string 2",
      "GroupNames": [
        {
          "Name": "sample string 1"
        },
        {
          "Name": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<GroupTypeNameEntryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <GroupTypeNames>
    <GroupTypeNameEntry>
      <GroupNames>
        <GroupName>
          <Name>sample string 1</Name>
        </GroupName>
        <GroupName>
          <Name>sample string 1</Name>
        </GroupName>
      </GroupNames>
      <GroupType>sample string 2</GroupType>
      <TypeID>1</TypeID>
    </GroupTypeNameEntry>
    <GroupTypeNameEntry>
      <GroupNames>
        <GroupName>
          <Name>sample string 1</Name>
        </GroupName>
        <GroupName>
          <Name>sample string 1</Name>
        </GroupName>
      </GroupNames>
      <GroupType>sample string 2</GroupType>
      <TypeID>1</TypeID>
    </GroupTypeNameEntry>
  </GroupTypeNames>
</GroupTypeNameEntryList>