SOAP API general – Evalanche Helpcenter

copy

Creates a copy of the resource specified by resource_id

EvalancheResourceInformation copy (int resource_id, int category_id)

Details

Parameter

int resource_id: ID of the resource to be copied
int category_id: ID of folder

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

Create <object>

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:copy>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead:copy>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:copyResponse>
 <copyResultv
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </copyResult>
 </ns1:copyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

delete

Deletes the resource.

bool delete (int resource_id)

Details

Parameter

int resource_id: ID of the resource to be deleted

Return value

bool: true if deletion was successful

Required rights

Manage object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:delete>
 <resource_id>OBJECT_ID</resource_id>
 </lead:delete>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:deleteResponse>
 <deleteResult>true</deleteResult>
 </ns1:deleteResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getAll

Lists all resources within a client.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details

Parameter

int mandator_id: ID of client

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the getById method (querying information about an object using the object ID)

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getAll>
 <mandator_id>MANDATOR_ID</mandator_id>
 </lead:getAll>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByCategory

Returns all objects of a folder

ArrayOfEvalancheResourceInformation[] getByCategory(int category_id)

Details

Parameters

int category_id: Id of folder

Return value

ArrayOfEvalancheResourceInformation[]: Array of objects with following attributes:
- string url: URL of object
- int type_id: Type-Id of object
- int category_id: Folder-Id of object
- int customer_id:Mandantor-Id of object
- int id: object-Id
- string name: Name of object

Required rights

Display object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </mail:getByCategory>
 </soapenv:Body>
</soapenv:Envelope></soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <SOAP-ENV:Body>
 <ns1:getByCategoryResponse>
 <getByCategoryResult>
 <item>
 <url>OBJECT_URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <id>OBJEKT_ID</id>
 <name>OBJEKT_NAME</name>
 </item>
 </getByCategoryResult>
 </ns1:getByCategoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getByExternalId

Outputs all direct mailing templates with a given EXTERNAL_ID.

ArrayOfEvalancheResourceInformation[] getByExternalId ( string external_id )

Details

Parameters

string external_id: object external id

Return value

ArrayOfEvalancheResourceInformation[]: List of objects with the following attributes:
- string url: URL of the object
- int type_id: Type-ID of the object
- int category_id: Folder ID of the object
- int customer_id: ID of the object
- int id: ID of the object
- string name: Name of the object

Required rights

Display object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getByExternalId>
 <external_id>EXTERNAL_ID</external_id>
 </mail:getByExternalId>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <SOAP-ENV:Body>
 <ns1:getByExternalIdResponse>
 <getByExternalIdResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <id>OBJECT_ID</id>
 <name>OBJECT_NAME</name>
 </item>
 </getByExternalIdResult>
 </ns1:getByExternalIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getById

Searches for a object using an ID.

EvalancheHashMap Profile::getById( int resource_id )

Details

Parameters

int resource_id: ID of the object to be searched

Return value

EvalancheHashMap data: EvalancheHashMap with the data of the object

Required rights

Display object

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:getById>
<resource_id>RESOURCE_ID</resource_id>
</prof:getById> 
</soapenv:Body> 
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:getByIdResponse>
<getByIdResult>
<items> 
<item> 
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_VALUE</value>
</item> 
[...]
</items> 
</getByIdResult>
</ns1:getByIdResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope>

getByModificationDate

Requesting an object via modification date

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

Details

Parameters

int start_date: Start date
int end_date: End date
int mandator_id: Id of mandator

Rückgabewert

item Array of objects with following attributes:.
- String url: Integration-URL of object
- int type_id: Type-Id of object
- int category_id: Folder-Id of object
- int customer_id: Customer-Id of object
- unix-timestamp last_modified: last modification date of object
- int id: Object-Id
- String name: Name of object

Required rights

none

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
 <soapenv:Header />
 <soapenv:Body>
 <art:getByModificationDate>
 <start_date>STARTDATE</start_date>
 <end_date>ENDDATE</end_date>
 <mandator_id>MANDATOR_ID</mandator_id>
 </art:getByModificationDate>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
 <ns1:getByModificationDateResponse>
 <getByModificationDateResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <last_modified>CHANGE_DATE</last_modified>
 <id>ID</id>
 <name>NAME</name>
 </item>
 <item>
 ...
 </item>
 </getByModificationDateResult>
 </ns1:getByModificationDateResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByTypeId

Retrieve all resources within this namespace with the specified resource type Id.

ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)

Details

Parameter

int type_id: Type id
int mandator_id: id of client

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the getById method (querying information about an object using the object id)

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </lead:getByCategory>
</soapenv:Body>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getJobState

Retrieves the state of a generic background-job

EvalancheResourceInformation getJobState (str job_id)

Details

Parameter

str job_id: The ID can be retrieved via `getConfiguration`, for example.

Return value

str id: Id of generic background-job
int status: returns the status of the background job
str status_description: the status message

Required rights

Display object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
 <cam:getJobState>
  <job_id>JOB_ID</job_id>
 </cam:getJobState>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/campaign">
<SOAP-ENV:Body>
<ns1:getJobStateResponse>
 <getJobStateResult>
  <id>ID</id>
  <status>0</status>
  <status_description>STATUS_DESCRIPTION</status_description>
 </getJobStateResult>
</ns1:getJobState>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getResourceDefaultCategory

Provides information about the default folder of objects

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details

Parameter

int customer_id: Customer ID

Return value

EvalancheCategoryInformation
- int: ID, Id of resource
- string: NAME, name of resource
- int: PARENT_ID, Id of parent folder

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getResourceDefaultCategory>
 <customer_id>CUSTUMER_ID</customer_id>
 </lead:getResourceDefaultCategory>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getResourceDefaultCategoryResponse>
 <getResourceDefaultCategoryResult>
 <id>ID</id>
 <name>NAME</name>
 <parent_id>PARENT_ID</parent_id>
 </getResourceDefaultCategoryResult>
 </ns1:getResourceDefaultCategoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getTypeIds

Reading the type Ids belonging to an object class

ArrayOfEvalancheResourceInformation getTypeIds ()

Details

Parameter

Return value

ArrayOfEvalancheResourceTypeInformation
- EvalancheResourceTypeInformation: ITEM
  - int: ID
  - string: DESCRIPTION

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getTypeIds />
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getTypeIdsResponse>
 <getTypeIdsResult>
 <item>
 <id>ID</id>
 <description>DESCRIPTION</description>
 </item>
 </getTypeIdsResult>
 </ns1:getTypeIdsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

Parameter

Return value

isAliveResponse
- IsAliveResult: IsAliveResult
  - string: STATUS
  - string: RANDOM_MESSAGE

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:isAlive />
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:isAliveResponse>
 <isAliveResult>
 <status>STATUS</status>
 <random_message>RANDOM_MESSAGE</random_message>
 </isAliveResult>
 </ns1:isAliveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

move

Moves the object to another folder

EvalancheResourceInformation move (int resource_id, int category_id)

Details

Parameter

int resource_id: ID of the object to be moved
int category_id: ID of target folder

Return value

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: RESOURCE_ID
- string: NAME

Required rights

Manage object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:move>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead:move>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:moveResponse>
 <moveResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </moveResult>
 </ns1:moveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

rename

Gives the object a different name

EvalancheResourceInformation rename (int resource_id, string name)

Details

Parameter

int resource_id: ID of the object to be renamed
string name: new name of the object

Return value

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: RESOURCE_ID
- string: NAME

Required rights

Edit object

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:rename>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </lead:rename>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:renameResponse>
 <renameResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <last_modified>1760363237</last_modified>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </renameResult>
 </ns1:renameResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Standard API (SOAP)

copy

Parameter

Return value

Required rights

Use

delete

Parameter

Return value

Required rights

Use

getAll

Parameter

Return value

Required rights

Use

getByCategory

Parameters

Return value

Required rights

Use

getByExternalId

Parameters

Return value

Required rights

Use

getById

Parameters

Return value

Required rights

Use

getByModificationDate

Parameters

Rückgabewert

Required rights

Use

getByTypeId

Parameter

Return value

Required rights

Use

getJobState

Parameter

Return value

Required rights

Use

getResourceDefaultCategory

Parameter

Return value

Required rights

Use

getTypeIds

Parameter

Return value

Required rights

Use

isAlive

Parameter

Return value

Required rights

Use

move

Parameter

Return value

Required rights

Use

rename

Parameter

Return value

Required rights

Use

Related articles