SearchByModifiedDateRange

Summary: Searches foods returning those which have a modified date between Start and End inclusive.

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

Request Type: FoodsByModifiedDateRangeRequest

Start
- Type: XmlDateTimeOffset
- The start of the range to search for. If empty, this value is unbounded.
End
- Type: XmlDateTimeOffset
- The end of the range to search for. If empty, this value is unbounded.
FilterByFoodTypes (Optional)
- FoodType[]
- Indicates which types of foods are returned. If empty, all foods are returned.
FilterByPublicationStates (Optional)
- PublicationState[]
- Indicates which foods with the given publication states are returned. If empty, only published foods are returned.
DataSourceFilter (Optional)
- String[]
- Indicates which sources (UserFoods / EshaFoods) to query from.
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: FoodsListResponse

Foods
- Type: FoodDto[]
- The list of foods obtained from the 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:typ="http://ns.esha.com/2013/types">
   <soap:Header/>
   <soap:Body>
      <gen:FoodsByModifiedDateRangeRequest>
         <gen:Start>
            <typ:DateTime>2018-01-01T06:00:00</typ:DateTime>
            <typ:UtcOffsetInMinutes>-480</typ:UtcOffsetInMinutes>
         </gen:Start>
         <gen:End>
            <typ:DateTime>2018-01-31T06:00:00</typ:DateTime>
            <typ:UtcOffsetInMinutes>-480</typ:UtcOffsetInMinutes>
         </gen:End>
         <gen:FilterByFoodTypes>
            <gen:FoodType>Ingredient</gen:FoodType>
            <gen:FoodType>Recipe</gen:FoodType>
         </gen:FilterByFoodTypes>
         <gen:DataSourceFilter>
            <gen:DataSource>EshaFoods</gen:DataSource>
            <gen:DataSource>UserFoods</gen:DataSource>
         </gen:DataSourceFilter>
         <gen:FilterByPublicationStates>
            <gen:PublicationState>Draft</gen:PublicationState>
            <gen:PublicationState>Published</gen:PublicationState>
         </gen:FilterByPublicationStates>
         <gen:StartIndex>1</gen:StartIndex>
         <gen:PageSize>3</gen:PageSize>
      </gen:FoodsByModifiedDateRangeRequest>
   </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/searchbymodifieddaterangeresponse</a:Action>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <FoodsListResponse xmlns="http://ns.esha.com/2013/genesisapi">
         <Foods>
            <Recipe>
               <Id xmlns="http://ns.esha.com/2013/exlx">8980ff36-c5ad-09d9-5ef8-ee69ecb67fee</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">Organic Deluxe Cheddar Mac with Cheddar Cheese Powder</Value>
               </Name>
               <Created xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2015-10-05T14:00:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-420</UtcOffsetInMinutes>
               </Created>
               <Modified xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2018-01-19T05:24:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-480</UtcOffsetInMinutes>
               </Modified>
               <UserCode xmlns="http://ns.esha.com/2013/exlx">117155</UserCode>
            </Recipe>
            <Recipe>
               <Id xmlns="http://ns.esha.com/2013/exlx">8980ff36-e430-3edc-5ef8-ee69ecb67fee</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">SAMPLE, Fruit Salad</Value>
               </Name>
               <Created xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2010-06-22T14:00:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-420</UtcOffsetInMinutes>
               </Created>
               <Modified xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2018-01-19T05:12:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-480</UtcOffsetInMinutes>
               </Modified>
            </Recipe>
            <Recipe>
               <Id xmlns="http://ns.esha.com/2013/exlx">8980ff36-13e6-642b-5ef8-ee69ecb67fee</Id>
               <Name xmlns="http://ns.esha.com/2013/exlx">
                  <Value xml:lang="en-US" xmlns="http://ns.esha.com/2013/types">Spaghetti Dinner</Value>
               </Name>
               <Created xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2014-07-03T14:00:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-420</UtcOffsetInMinutes>
               </Created>
               <Modified xmlns="http://ns.esha.com/2013/exlx">
                  <DateTime xmlns="http://ns.esha.com/2013/types">2018-01-19T05:11:00.0000000</DateTime>
                  <UtcOffsetInMinutes xmlns="http://ns.esha.com/2013/types">-480</UtcOffsetInMinutes>
               </Modified>
               <UserCode xmlns="http://ns.esha.com/2013/exlx">XYZ 123</UserCode>
            </Recipe>
         </Foods>
         <ResponseVersion>1.0.0.0</ResponseVersion>
         <Status>
            <StatusMessage>Ok</StatusMessage>
            <StatusCode>200</StatusCode>
         </Status>
      </FoodsListResponse>
   </s:Body>
</s:Envelope>

REST Request

POST http://localhost:80/rest/FoodQueryService.svc/SearchByModifiedDateRange HTTP/1.1
Content-Type: text/plain
Host: localhost:80

request={"Start":{"DateTime":"2018-01-01T06:00:00", "UtcOffsetInMinutes":"-480"}, "End":{"DateTime":"2018-01-31T06:00:00", "UtcOffsetInMinutes":"-480"}, "StartIndex":1, "PageSize":3, "FilterByPublicationStates":["Draft", "Published"], "DataSourceFilter":["UserFoods", "EshaFoods"], "FilterByFoodTypes":["Ingredient", "Recipe"]}

REST Response

{
    "Foods": [
        {
            "$type": "Esha.DomainModel.Serialization.RecipeDto, Esha.DomainModel.Serialization",
            "HaccpIdsSpecified": false,
            "CookMethod": null,
            "CookTemperature": null,
            "CookTime": null,
            "Instructions": null,
            "HaccpHeadingLevelSpecified": false,
            "PanSize": null,
            "PreparationTime": null,
            "ContentClaimReferenceIdSpecified": false,
            "DefinedServingWeightConversion": null,
            "NutrientContentClaimsText": null,
            "FoodType": 82,
            "Name": {
                "en-US": "Organic Deluxe Cheddar Mac with Cheddar Cheese Powder"
            },
            "CommonName": null,
            "Description": null,
            "Notes": null,
            "DefiningAmount": null,
            "AmountCost": null,
            "DefaultWeightUnitIdSpecified": false,
            "ConversionMapIdSpecified": false,
            "Conversions": null,
            "ItemsSpecified": false,
            "AnalysesSpecified": false,
            "GlycemicIndex": null,
            "Created": {
                "DateTime": "2015-10-05T14:00:00.0000000",
                "UtcOffsetInMinutes": -420
            },
            "CreatedSpecified": true,
            "Modified": {
                "DateTime": "2018-01-19T05:24:00.0000000",
                "UtcOffsetInMinutes": -480
            },
            "ModifiedSpecified": true,
            "LegacyKeySpecified": false,
            "LegacyNutrientRefNumSpecified": false,
            "LegacyYieldKeySpecified": false,
            "UserCode": "117155",
            "UsdaCodeSpecified": false,
            "EshaCodeSpecified": false,
            "OwnerName": null,
            "AlternateNamesSpecified": false,
            "AllergenStatementSettingsSpecified": false,
            "IngredientStatementSettingsSpecified": false,
            "AllergenStatementsSpecified": false,
            "IngredientStatementsSpecified": false,
            "Brand": null,
            "GroupsIdsSpecified": false,
            "NutrientTransformIdsSpecified": false,
            "ImagesSpecified": false,
            "LabelsSpecified": false,
            "AnalysisOverrides": null,
            "PropertyValues": null,
            "Id": "8980ff36-c5ad-09d9-5ef8-ee69ecb67fee",
            "IdSpecified": true
        },
        {
            "$type": "Esha.DomainModel.Serialization.RecipeDto, Esha.DomainModel.Serialization",
            "HaccpIdsSpecified": false,
            "CookMethod": null,
            "CookTemperature": null,
            "CookTime": null,
            "Instructions": null,
            "HaccpHeadingLevelSpecified": false,
            "PanSize": null,
            "PreparationTime": null,
            "ContentClaimReferenceIdSpecified": false,
            "DefinedServingWeightConversion": null,
            "NutrientContentClaimsText": null,
            "FoodType": 82,
            "Name": {
                "en-US": "SAMPLE, Fruit Salad"
            },
            "CommonName": null,
            "Description": null,
            "Notes": null,
            "DefiningAmount": null,
            "AmountCost": null,
            "DefaultWeightUnitIdSpecified": false,
            "ConversionMapIdSpecified": false,
            "Conversions": null,
            "ItemsSpecified": false,
            "AnalysesSpecified": false,
            "GlycemicIndex": null,
            "Created": {
                "DateTime": "2010-06-22T14:00:00.0000000",
                "UtcOffsetInMinutes": -420
            },
            "CreatedSpecified": true,
            "Modified": {
                "DateTime": "2018-01-19T05:12:00.0000000",
                "UtcOffsetInMinutes": -480
            },
            "ModifiedSpecified": true,
            "LegacyKeySpecified": false,
            "LegacyNutrientRefNumSpecified": false,
            "LegacyYieldKeySpecified": false,
            "UserCode": null,
            "UsdaCodeSpecified": false,
            "EshaCodeSpecified": false,
            "OwnerName": null,
            "AlternateNamesSpecified": false,
            "AllergenStatementSettingsSpecified": false,
            "IngredientStatementSettingsSpecified": false,
            "AllergenStatementsSpecified": false,
            "IngredientStatementsSpecified": false,
            "Brand": null,
            "GroupsIdsSpecified": false,
            "NutrientTransformIdsSpecified": false,
            "ImagesSpecified": false,
            "LabelsSpecified": false,
            "AnalysisOverrides": null,
            "PropertyValues": null,
            "Id": "8980ff36-e430-3edc-5ef8-ee69ecb67fee",
            "IdSpecified": true
        },
        {
            "$type": "Esha.DomainModel.Serialization.RecipeDto, Esha.DomainModel.Serialization",
            "HaccpIdsSpecified": false,
            "CookMethod": null,
            "CookTemperature": null,
            "CookTime": null,
            "Instructions": null,
            "HaccpHeadingLevelSpecified": false,
            "PanSize": null,
            "PreparationTime": null,
            "ContentClaimReferenceIdSpecified": false,
            "DefinedServingWeightConversion": null,
            "NutrientContentClaimsText": null,
            "FoodType": 82,
            "Name": {
                "en-US": "Spaghetti Dinner"
            },
            "CommonName": null,
            "Description": null,
            "Notes": null,
            "DefiningAmount": null,
            "AmountCost": null,
            "DefaultWeightUnitIdSpecified": false,
            "ConversionMapIdSpecified": false,
            "Conversions": null,
            "ItemsSpecified": false,
            "AnalysesSpecified": false,
            "GlycemicIndex": null,
            "Created": {
                "DateTime": "2014-07-03T14:00:00.0000000",
                "UtcOffsetInMinutes": -420
            },
            "CreatedSpecified": true,
            "Modified": {
                "DateTime": "2018-01-19T05:11:00.0000000",
                "UtcOffsetInMinutes": -480
            },
            "ModifiedSpecified": true,
            "LegacyKeySpecified": false,
            "LegacyNutrientRefNumSpecified": false,
            "LegacyYieldKeySpecified": false,
            "UserCode": "XYZ 123",
            "UsdaCodeSpecified": false,
            "EshaCodeSpecified": false,
            "OwnerName": null,
            "AlternateNamesSpecified": false,
            "AllergenStatementSettingsSpecified": false,
            "IngredientStatementSettingsSpecified": false,
            "AllergenStatementsSpecified": false,
            "IngredientStatementsSpecified": false,
            "Brand": null,
            "GroupsIdsSpecified": false,
            "NutrientTransformIdsSpecified": false,
            "ImagesSpecified": false,
            "LabelsSpecified": false,
            "AnalysisOverrides": null,
            "PropertyValues": null,
            "Id": "8980ff36-13e6-642b-5ef8-ee69ecb67fee",
            "IdSpecified": true
        }
    ],
    "Status": {
        "StatusMessage": 200,
        "StatusCode": 200,
        "StatusDetail": null
    },
    "ResponseVersion": {}
}