| Name | Type | Description |
|---|
| start | XmlDateTimeOffset | The earliest modification date included in the response foods. Use null for search results. Do not include start for no start bound. DateTime MUST be in UTCBe sure to review the guidelines for formatting XmlDateTimeOffset requests. | Code Block |
|---|
| language | js |
|---|
| title | JSON Example |
|---|
| "Start":{"DateTime":"2015-06-01T00:00:00","UtcOffsetInMinutes":-480} |
| Code Block |
|---|
| language | xml |
|---|
| title | XML Example |
|---|
| <api:Start><exlx:DateTime>2015-06-01T00:00:00</exlx:DateTime><exlx:UtcOffsetInMinutes>-480</exlx:UtcOffsetInMinutes></api:Start |
|
| end | XmlDateTimeOffset | The latest modification date included in the response foods. Use nullsearch results. Do not include end for no end bound. DateTime MUST be in UTCBe sure to review the guidelines for formatting XmlDateTimeOffset requests. | Code Block |
|---|
| language | js |
|---|
| title | JSON Example |
|---|
| "End":{"DateTime":"2015-06-30T00:00:00","UtcOffsetInMinutes":-480} |
| Code Block |
|---|
| language | xml |
|---|
| title | XML Example |
|---|
| <api:End><exlx:DateTime>2015-06-30T23:59:59</exlx:DateTime><exlx:UtcOffsetInMinutes>-480</exlx:UtcOffsetInMinutes></api:End> |
|
| startrow | int | The first food included in the search results. The default value is 1. | Code Block |
|---|
| <StartRow>10</StartRow> |
|
| pagesize | int | The number of foods included in the search results. The default value is the total number of search results after startrow. | Code Block |
|---|
| <PageSize>10</PageSize |
|
Formatting XmlDateTimeOffset Requests
The "DateTime" property in the XmlDateTimeOffset request must be converted from the local system time to UTC time, and the local system UTC offset must be converted to minutes and included in the "UtcOffsetInMinutes" property.
For example, a request must be formatted as follows if my system time is PST (-08:00):
| Code Block |
|---|
| language | js |
|---|
| title | Sample JSON Request |
|---|
|
{
"Start":{"DateTime":"2017-01-01T08:00:00","UtcOffsetInMinutes":-480},
"End":{"DateTime":"2017-01-01T08:15:00","UtcOffsetInMinutes":-480}
} |
The UtcOffsetInMinutes is applied to the UTC DateTime value in order to represent the local time and this request will return any foods modified between 2017-01-01 12:00 and 2017-01-01 12:15 local server time.