SOAP image – Evalanche Helpcenter

The following SOAP methods are provided specifically for creating images.

Methods

copy

Creates a copy of the resource specified by resource_id

EvalancheResourceInformation copy (int resource_id, int category_id)

Details: copy

create

Creates a new image

EvalancheResourceInformation create(string image_base64, string name, int category_id )

Details

Parameters

string image_base64: base64 encoded image data
string name: Name of the image to be created
int category_id: Id of the folder in which the image should be created

Return value

EvalancheResourceInformation: Object analogous to the method getById (Query information about an object using object Id)

Required rights

Create image

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:imag="https://scnem.com/soap.php/soap/image">
 <soapenv:Header/>
 <soapenv:Body>
 <imag:create>
 <image_base64>BASE64_IMAGE</image_base64>
 <name>NAME</name>
 <category_id>FOLDER_ID</category_id>
 </imag:create>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/image">
 <SOAP-ENV:Body>
 <ns1:createResponse>
 <createResult>
 <url>IMAGE_URL</url>
 <type_id>IMAGE_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>IMAGE_ID</id>
 <name>IMAGE_NAME</name>
 </createResult>
 </ns1:createResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

delete

Deletes the resource.

bool delete (int resource_id)

Details: delete

getAll

Lists all resources within a client.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details: getAll

getByCategory

Returns all objects of a folder.

ArrayOfEvalancheResourceInformation getByCategory (int category_id)

Details: getByCategory

getByExternalId

Outputs all direct mailing templates with a given EXTERNAL_ID.

ArrayOfEvalancheResourceInformation[] getByExternalId ( string external_id )

Details: getByExternalId

getById

Searches for a object using an ID.

EvalancheHashMap Profile::getById( int resource_id )

Details: getById

getByModificationDate

Requesting an object via modification date

EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)

Details: getByModificationDate

getByTypeId

Retrieve all resources within this namespace with the specified resource type ID (see the getTypeIds method).

ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)

Details: getByTypeId

getResourceDefaultCategory

Provides information about the default folder of objects

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details: getResourceDefaultCategory

getTypeIds

Reading the type Ids belonging to an object class

ArrayOfEvalancheResourceInformation getTypeIds ()

Details: getTypeIds

isAlive

Tests whether the API is available and the credentials used are valid. The `random_message` property of the result is completely irrelevant, since the values are randomly taken from http://whatthecommit.com.

isAliveResponse isAlive ()

Details: isAlive

move

Moves the object to another folder

EvalancheResourceInformation move (int resource_id, int category_id)

Details: move

rename

Gives the object a different name

EvalancheResourceInformation rename (int resource_id, string name)

Details: rename

Standard API (SOAP)