POST Api/StorageCustomer/ItemsByIds

Retreives media -items from OPV Storage identified by an array of ids, and the requested size and image-type. An items image-link is generated by this method.

Request Information

URI Parameters

None.

Body Parameters

ServiceItemRequest
NameDescriptionTypeAdditional information
ItemIds

Represents a list of unique item-ids. The response is not guaranteed to be in that particular order.

Collection of integer

None.

ImageFormat

The requested fileformat, valid values are: <br /><br /> Jpg, Png, Tiff and Tga.

string

None.

Size

The requested image size: <br /> px50, px66, px75, px100, px150, px200, px250, px300, px400, px500, px750, px1000, px1500, px2000 and Original.<br />

string

None.

UseUserFriendlyImageLinks

Optional : If set to true the imagelink is "userfriendly", otherwise its the default one.

boolean

None.

IncludeExtrafields

Optional : If set to true, the response also contains the extrafields of the item.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ItemIds": [
    1,
    2
  ],
  "ImageFormat": "sample string 1",
  "Size": "sample string 2",
  "UseUserFriendlyImageLinks": true,
  "IncludeExtrafields": true
}

application/xml, text/xml

Sample:
<ServiceItemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OPVCustomerServiceWebAPI.Models.CustomerService">
  <ImageFormat>sample string 1</ImageFormat>
  <IncludeExtrafields>true</IncludeExtrafields>
  <ItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ItemIds>
  <Size>sample string 2</Size>
  <UseUserFriendlyImageLinks>true</UseUserFriendlyImageLinks>
</ServiceItemRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 - OK
400 - Bad request - some or all of the parameters are bad.
403 - Access was denied. Headerparameter auth_token invalid or not present in JSON-header.
500 - Serverside exception.

JsonResultOfListOfItem
NameDescriptionTypeAdditional information
Content

Collection of Item

None.

SerializerSettings

JsonSerializerSettings

None.

Encoding

Encoding

None.

Request

HttpRequestMessage

None.

Response Formats

application/json, text/json

Sample:

Sample not available.