# StyleApi.ImageApi

All URIs are relative to *http://api-prod.stylelens.io*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getImageByHostcodeAndProductNo**](ImageApi.md#getImageByHostcodeAndProductNo) | **GET** /images/hosts/{hostCode}/images/{productNo} | Get Image by hostCode and productNo
[**getImageById**](ImageApi.md#getImageById) | **GET** /images/{imageId} | Find Images by ID
[**getImages**](ImageApi.md#getImages) | **GET** /images | Get Images by imageId
[**getImagesByObjectId**](ImageApi.md#getImagesByObjectId) | **GET** /images/objects/{objectId} | Query to search images by object id
[**getImagesByUserImageFile**](ImageApi.md#getImagesByUserImageFile) | **POST** /images/userImages | Query to search images
[**getImagesByUserImageIdAndObjectIndex**](ImageApi.md#getImagesByUserImageIdAndObjectIndex) | **GET** /images/userImages/{userImageId}/objects/{objectIndex} | Get Images by userImageId and objectIndex


<a name="getImageByHostcodeAndProductNo"></a>
# **getImageByHostcodeAndProductNo**
> GetImageResponse getImageByHostcodeAndProductNo(hostCode, productNo)

Get Image by hostCode and productNo

Returns Image belongs to a Host and productNo

### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var hostCode = "hostCode_example"; // String | 

var productNo = "productNo_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImageByHostcodeAndProductNo(hostCode, productNo, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hostCode** | **String**|  | 
 **productNo** | **String**|  | 

### Return type

[**GetImageResponse**](GetImageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImageById"></a>
# **getImageById**
> GetImageResponse getImageById(imageId)

Find Images by ID

Returns a single Image

### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var imageId = "imageId_example"; // String | ID of Image to return


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImageById(imageId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **imageId** | **String**| ID of Image to return | 

### Return type

[**GetImageResponse**](GetImageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImages"></a>
# **getImages**
> GetImagesResponse getImages(imageId, opts)

Get Images by imageId

Returns similar Images with imageId

### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var imageId = "imageId_example"; // String | 

var opts = { 
  'offset': 56, // Number | 
  'limit': 56 // Number | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImages(imageId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **imageId** | **String**|  | 
 **offset** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 

### Return type

[**GetImagesResponse**](GetImagesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImagesByObjectId"></a>
# **getImagesByObjectId**
> GetImagesResponse getImagesByObjectId(objectId, opts)

Query to search images by object id



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var objectId = "objectId_example"; // String | 

var opts = { 
  'offset': 56, // Number | 
  'limit': 56 // Number | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesByObjectId(objectId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectId** | **String**|  | 
 **offset** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 

### Return type

[**GetImagesResponse**](GetImagesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getImagesByUserImageFile"></a>
# **getImagesByUserImageFile**
> GetImagesResponse getImagesByUserImageFile(opts)

Query to search images



### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var opts = { 
  'file': "/path/to/file.txt", // File | User's Image file to upload (only support jpg format yet)
  'offset': 56, // Number | 
  'limit': 56 // Number | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesByUserImageFile(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file** | **File**| User&#39;s Image file to upload (only support jpg format yet) | [optional] 
 **offset** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 

### Return type

[**GetImagesResponse**](GetImagesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

<a name="getImagesByUserImageIdAndObjectIndex"></a>
# **getImagesByUserImageIdAndObjectIndex**
> GetImagesResponse getImagesByUserImageIdAndObjectIndex(userImageId, objectIndex)

Get Images by userImageId and objectIndex

Returns Images belongs to a userImageId and objectIndex

### Example
```javascript
var StyleApi = require('style_api');

var apiInstance = new StyleApi.ImageApi();

var userImageId = "userImageId_example"; // String | 

var objectIndex = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImagesByUserImageIdAndObjectIndex(userImageId, objectIndex, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userImageId** | **String**|  | 
 **objectIndex** | **Number**|  | 

### Return type

[**GetImagesResponse**](GetImagesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json