Upload Card Background Image

Description

Updates the card background

HTTP Method

PUT

Path

/identities/{identityId}/bgImage

Authentication

Requires an authenticated user.

Parameters

Table 36.  Parameters for " Upload Card Background Image "

NameTypeValue TypeDescription
identityIdPATHlongThe identity id for which to update the background image.
topLeftXCropQUERYintThe top left X co-ordinate to crop the image at.
topLeftYCropQUERYintThe top left Y co-ordinate to crop the image at.
bottomRightXCropQUERYintThe bottom right X co-ordinate to crop the image at.
bottomRightYCropQUERYintthe bottom right Y co-ordinate to crop the image at
backgroundBODYInputStreamThe background image data as bytes.

Error Codes

150001 ( Common )

The endpoint requires an authenticated account

40000 ( Identity )

An unhanded exception occured.

40007 ( Identity )

Don't have the permission to access the identity.

40008 ( Identity )

The image type is not supported. Supported image formats are: jpeg, png, bmp, gif.

40011 ( Identity )

Not allowed to upload a card background image when the card is linked to a campaign!

40016 ( Identity )

Don't have the permission to execute this request

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>