POST api/v1/images/{image_id}/crop

Request Information

URI Parameters

NameDescriptionTypeAdditional information
image_id

globally unique identifier

Required

Body Parameters

ImageCrop
NameDescriptionTypeAdditional information
x

decimal number

None.

y

decimal number

None.

width

decimal number

None.

height

decimal number

None.

use_percent

boolean

None.

aspect_ratio

string

None.

background

string

None.

Request Formats

application/json, text/json

Sample:
{
  "x": 1.0,
  "y": 1.0,
  "width": 1.0,
  "height": 1.0,
  "use_percent": true,
  "aspect_ratio": "sample string 1",
  "background": "sample string 2"
}

application/xml, text/xml

Sample:
<ImageCrop xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <aspect_ratio>sample string 1</aspect_ratio>
  <background>sample string 2</background>
  <height>1</height>
  <use_percent>true</use_percent>
  <width>1</width>
  <x>1</x>
  <y>1</y>
</ImageCrop>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
messages

Collection of ResultMessage

None.

count_of_errors

integer

None.

id

Object

None.

name

string

None.

data

Object

None.

url

string

None.

text

string

None.

inner_exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "messages": [
    {
      "type": 1,
      "code": 1,
      "message": "sample string 1",
      "field": "sample string 2"
    },
    {
      "type": 1,
      "code": 1,
      "message": "sample string 1",
      "field": "sample string 2"
    }
  ],
  "count_of_errors": 1,
  "id": {},
  "name": "sample string 3",
  "data": {},
  "url": "sample string 5",
  "text": "sample string 6",
  "inner_exception": "sample string 7"
}

application/xml, text/xml

Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UP.Core.Data">
  <count_of_errors>1</count_of_errors>
  <data />
  <id />
  <inner_exception>sample string 7</inner_exception>
  <messages>
    <ResultMessage>
      <code>1</code>
      <field>sample string 2</field>
      <message>sample string 1</message>
      <type>1</type>
    </ResultMessage>
    <ResultMessage>
      <code>1</code>
      <field>sample string 2</field>
      <message>sample string 1</message>
      <type>1</type>
    </ResultMessage>
  </messages>
  <name>sample string 3</name>
  <text>sample string 6</text>
  <url>sample string 5</url>
</Result>