GET api/ReferenceGroup/{auth}

Retrieve the list of reference groups

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required

Body Parameters

None.

Response Information

Resource Description

ReferenceGroupResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Items	List of reference groups	Collection of ReferenceGroupItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Items": [
    {
      "Description": "sample string 3",
      "DropDownDisplay": "sample string 6",
      "Name": "sample string 2",
      "ReferenceGroupGUID": "sample string 1",
      "UserGUID": "sample string 4",
      "UserGroupGUID": "sample string 5"
    },
    {
      "Description": "sample string 3",
      "DropDownDisplay": "sample string 6",
      "Name": "sample string 2",
      "ReferenceGroupGUID": "sample string 1",
      "UserGUID": "sample string 4",
      "UserGroupGUID": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<ReferenceGroupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Items>
    <ReferenceGroupItem>
      <Description>sample string 3</Description>
      <DropDownDisplay>sample string 6</DropDownDisplay>
      <Name>sample string 2</Name>
      <ReferenceGroupGUID>sample string 1</ReferenceGroupGUID>
      <UserGUID>sample string 4</UserGUID>
      <UserGroupGUID>sample string 5</UserGroupGUID>
    </ReferenceGroupItem>
    <ReferenceGroupItem>
      <Description>sample string 3</Description>
      <DropDownDisplay>sample string 6</DropDownDisplay>
      <Name>sample string 2</Name>
      <ReferenceGroupGUID>sample string 1</ReferenceGroupGUID>
      <UserGUID>sample string 4</UserGUID>
      <UserGroupGUID>sample string 5</UserGroupGUID>
    </ReferenceGroupItem>
  </Items>
</ReferenceGroupResp>