POST api/Images/All

Return a batch of image class objects (max 10,000 at a time).

Request Information

URI Parameters

None.

Body Parameters

RecordSelection class (passed in the request body)

EskimoClassLibraries.RecordSelectionWithDate
NameDescriptionTypeAdditional information
TimeStampFrom

Optional property that enables you to only receive products that have been added or modified in the Eskimo system since this timestamp.

 date

None.
StartPosition

Initially, pass 1 to return the first record.

 integer

Required

Range: inclusive between 1 and 2147483647
RecordCount

The number of records to be returned.

 integer

Required

Range: inclusive between 1 and 10000

Request Formats

application/json, text/json

Sample: 
{
  "TimeStampFrom": "2025-01-18T04:03:06.5403902+00:00",
  "StartPosition": 2,
  "RecordCount": 3
}

application/xml, text/xml

Sample: 
<RecordSelectionWithDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <RecordCount>3</RecordCount>
  <StartPosition>2</StartPosition>
  <TimeStampFrom>2025-01-18T04:03:06.5403902+00:00</TimeStampFrom>
</RecordSelectionWithDate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsImage
NameDescriptionTypeAdditional information
EskimoImageID

The numeric ID of the Image as generated from Eskimo

 integer

Required
WebImageID

The ID of the image as known by the cart

 string

None.
FileName

The name of the file when it was imported into Eskimo

 string

Required
Width

The width of the image in pixels

 integer

Required
Height

The height of the image in pixels

 integer

Required
Created

The date that the image was added in Eskimo

 date

None.
LastModified

The date that the image was replaced or amended in Eskimo.

 date

None.
FileSize

The size of the image in Bytes

 integer

Required
AlternateText

Alternate Text for an image as used here: http://www.w3schools.com/tags/att_img_alt.asp

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "EskimoImageID": 1,
    "WebImageID": "sample string 2",
    "FileName": "sample string 3",
    "Width": 4,
    "Height": 5,
    "Created": "2025-01-18T04:03:06.5403902+00:00",
    "LastModified": "2025-01-18T04:03:06.5403902+00:00",
    "FileSize": 8,
    "AlternateText": "sample string 9"
  },
  {
    "EskimoImageID": 1,
    "WebImageID": "sample string 2",
    "FileName": "sample string 3",
    "Width": 4,
    "Height": 5,
    "Created": "2025-01-18T04:03:06.5403902+00:00",
    "LastModified": "2025-01-18T04:03:06.5403902+00:00",
    "FileSize": 8,
    "AlternateText": "sample string 9"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfclsImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsImage>
    <AlternateText>sample string 9</AlternateText>
    <Created>2025-01-18T04:03:06.5403902+00:00</Created>
    <EskimoImageID>1</EskimoImageID>
    <FileName>sample string 3</FileName>
    <FileSize>8</FileSize>
    <Height>5</Height>
    <LastModified>2025-01-18T04:03:06.5403902+00:00</LastModified>
    <WebImageID>sample string 2</WebImageID>
    <Width>4</Width>
  </clsImage>
  <clsImage>
    <AlternateText>sample string 9</AlternateText>
    <Created>2025-01-18T04:03:06.5403902+00:00</Created>
    <EskimoImageID>1</EskimoImageID>
    <FileName>sample string 3</FileName>
    <FileSize>8</FileSize>
    <Height>5</Height>
    <LastModified>2025-01-18T04:03:06.5403902+00:00</LastModified>
    <WebImageID>sample string 2</WebImageID>
    <Width>4</Width>
  </clsImage>
</ArrayOfclsImage>