ListRecommendationProfiles

Owned by Nate Edwards
Last updated: Oct 24, 2018 by Alex Caroline
4 min read

Summary: Provides a list of all recommendation profiles

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

Request Type: RecommendationProfilesListRequest

  • ForAuthority
    • Type: exlx:AuthorityDto
    • The authority for the given recommendation profile.
  • 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: RecommendationProfilesListResponse

  • RecommendationProfiles
    • RecommendationProfileDto[]
    • The list of Recommendation Profiles 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" xmlns:exlx="http://ns.esha.com/2013/exlx" xmlns:typ="http://ns.esha.com/2013/types">
   <soap:Header/>
   <soap:Body>
      <gen:RecommendationProfilesListRequest>
         <gen:StartIndex>1</gen:StartIndex>
         <gen:PageSize>3</gen:PageSize>
      </gen:RecommendationProfilesListRequest>
   </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/listrecommendationprofilesresponse</a:Action>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <RecommendationProfilesListResponse xmlns="http://ns.esha.com/2013/genesisapi">
         <RecommendationProfiles>
            <RecommendationProfile>
               <Id xmlns="http://ns.esha.com/2013/exlx">9e5fc62a-0fe6-11e1-bb3f-b8ac6fac0ca7</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">US Label Adult</Value>
               </Name>
               <ActivityLevel xmlns="http://ns.esha.com/2013/exlx">Unspecified</ActivityLevel>
               <Authority xmlns="http://ns.esha.com/2013/exlx">
                  <Id>bbf4846d-8400-43bb-944d-6021fda98225</Id>
                  <Name>
                     <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">United States</Value>
                  </Name>
                  <Iso3166Alpha2>US</Iso3166Alpha2>
                  <Iso3166Alpha3>USA</Iso3166Alpha3>
                  <Iso3166Numeric>840</Iso3166Numeric>
               </Authority>
               <Recommendations xmlns="http://ns.esha.com/2013/exlx"/>
            </RecommendationProfile>
         </RecommendationProfiles>
         <ResponseVersion>1.0.0.0</ResponseVersion>
         <Status>
            <StatusMessage>Ok</StatusMessage>
            <StatusCode>200</StatusCode>
         </Status>
      </RecommendationProfilesListResponse>
   </s:Body>
</s:Envelope>
REST Request 
POST http://localhost:80/rest/FoodQueryService.svc/ListRecommendationProfiles HTTP/1.1
Content-Type: text/plain
Host: localhost:80

request={"StartIndex":1, "PageSize":3}
REST Response 
{
    "RecommendationProfiles": [
        {
            "Name": {
                "en-US": "US Label Adult"
            },
            "GenderSpecified": false,
            "AgeHighDaysSpecified": false,
            "AgeLowDaysSpecified": false,
            "HeightCentimetersSpecified": false,
            "WeightKilogramsSpecified": false,
            "ActivityLevel": 0,
            "ActivityLevelSpecified": true,
            "Authority": {
                "Name": {
                    "en-US": "United States"
                },
                "Iso3166Alpha2": "US",
                "Iso3166Alpha3": "USA",
                "Iso3166Numeric": 840,
                "Iso3166NumericSpecified": true,
                "Id": "bbf4846d-8400-43bb-944d-6021fda98225",
                "IdSpecified": true
            },
            "Recommendations": [],
            "Id": "9e5fc62a-0fe6-11e1-bb3f-b8ac6fac0ca7",
            "IdSpecified": true
        }
    ],
    "Status": {
        "StatusMessage": 200,
        "StatusCode": 200,
        "StatusDetail": null
    },
    "ResponseVersion": {}
}