ListGroups (4.0)

Owned by Nate Edwards
Last updated: Feb 14, 2020 by Josh Luth
5 min read

Summary: Provides a list of groups.

Soap Action: http://ns.esha.com/2013/genesisapi/ListGroups

Request Type: GroupsListRequest

  • StartIndex (Optional)
    • Type: Int
    • The index offset. If empty, index starts at 1.
  • PageSize (Optional)
    • Type: Int
    • The number of foods to return in the response. If empty, all records are returned.

Response Type: GroupsListResponse

  • Groups
    • Type: GroupDto[]
    • List of groups obtained from the given request.
  • Status
    • Type: exlx:ResultStatus
    • The ResultStatus of the given response
  • ResponseVersion
    • Type: exlx:XmlVersion
    • The version of the given response.


SOAP Request 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://ns.esha.com/2013/genesisapi">
   <soap:Header/>
   <soap:Body>
      <gen:GroupsListRequest>
         <gen:StartIndex>1</gen:StartIndex>
         <gen:PageSize>3</gen:PageSize>
      </gen:GroupsListRequest>
   </soap:Body>
</soap:Envelope>
SOAP Response 
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://ns.esha.com/2013/genesisapi/listgroupsresponse</a:Action>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GroupsListResponse xmlns="http://ns.esha.com/2013/genesisapi">
         <Groups>
            <Group>
               <Id xmlns="http://ns.esha.com/2013/exlx">6748e1fb-000a-0000-1900-705b14f8f910</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">My Recipes</Value>
               </Name>
               <GroupType xmlns="http://ns.esha.com/2013/exlx">Food</GroupType>
            </Group>
            <Group>
               <Id xmlns="http://ns.esha.com/2013/exlx">6748e1fb-000c-0000-1900-705b14f8f910</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">My Ingredients</Value>
               </Name>
               <GroupType xmlns="http://ns.esha.com/2013/exlx">Food</GroupType>
            </Group>
            <Group>
               <Id xmlns="http://ns.esha.com/2013/exlx">6748e1fb-00c9-0000-1900-705b14f8f910</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">Kosher</Value>
               </Name>
               <GroupType xmlns="http://ns.esha.com/2013/exlx">Food</GroupType>
               <Foods xmlns="http://ns.esha.com/2013/exlx">
                  <Id>752eb9c2-f371-472d-bede-d3a51c0fdeba</Id>
               </Foods>
            </Group>
         </Groups>
         <ResponseVersion>1.0.0.0</ResponseVersion>
         <Status>
            <StatusMessage>Ok</StatusMessage>
            <StatusCode>200</StatusCode>
         </Status>
      </GroupsListResponse>
   </s:Body>
</s:Envelope>
REST Request 
POST http://localhost:80/rest/FoodQueryService.svc/ListGroups HTTP/1.1
Content-Type: text/plain
Host: localhost:80

request={"StartIndex":1, "PageSize":3}
REST Response 
{
    "Groups": [
        {
            "Name": {
                "en-US": "My Recipes"
            },
            "ParentIdSpecified": false,
            "ParentGroupName": null,
            "GroupType": 70,
            "NutrientIdsSpecified": false
            "FoodIdsSpecified": false,
            "ConsumerIdsSpecified": false,
            "AllergenRulesSpecified": false,
            "Id": "6748e1fb-000a-0000-1900-705b14f8f910",
            "IdSpecified": true
        },
        {
            "Name": {
                "en-US": "My Ingredients"
            },
            "ParentIdSpecified": false,
            "ParentGroupName": null,
            "GroupType": 70,
            "NutrientIdsSpecified": false,
            "FoodIdsSpecified": false,
            "ConsumerIdsSpecified": false,
            "AllergenRulesSpecified": false,
            "Id": "6748e1fb-000c-0000-1900-705b14f8f910",
            "IdSpecified": true
        },
        {
            "Name": {
                "en-US": "Kosher"
            },
            "ParentIdSpecified": false,
            "ParentGroupName": null,
            "GroupType": 70,
            "NutrientIdsSpecified": false,
            "FoodIds": [
                "752eb9c2-f371-472d-bede-d3a51c0fdeba"
            ],
            "FoodIdsSpecified": true,
            "ConsumerIdsSpecified": false,
            "AllergenRulesSpecified": false,
            "Id": "6748e1fb-00c9-0000-1900-705b14f8f910",
            "IdSpecified": true
        }
    ],
    "Status": {
        "StatusMessage": 200,
        "StatusCode": 200,
        "StatusDetail": null
    },
    "ResponseVersion": {}
}