API DATABASE

From Xminder
Jump to: navigation, search

Xminder API DATABASE Documentation

Contents


Insert Records


Insert a record in the database.
Parameter Description Example
key

The access key to make a request to a module.

This key is provided by Xminder's administrators and it must NOT be published.

The default value for this parameter is NULL.

5d952f8293148969d4c87518e5524641
database

The ID of the database table in wich the insert is made.

1111
field's_name1 [&field's_name2]

The field or fields in the database table.

At least one database field should appear in the URL.

The database fields are separated by "&" (ampersand symbol).

FirstName=John

FirstName=John&LastName=Doe

FirstName=John&PhoneCell=00000000

keyword

The action that will be executed after the insert.

The keyword parameter is defined on the interface.

Please see the Desktop / Database: Define keyword section for detailed instruction.

sms

email

something else

Observations:
  1. The parameters key, database and [field's_name] are required parameters.
  2. The values of the parameters key, database and [field's_name] from the table above (column Example) are not valid.


Simple Example


URL: https://api.xminder.com/database.insert?key=5d955f8293148969d4b82518e5524646&database=1111&FirstName=value&LastName=value&PhoneCell=value&PhoneHome=value&PhoneOffice=value&Email=value&keyword=sms

Success:
<response>
    <success>true</success>
</response>


Error:

<response>
    <success>false</success>
    <error>E_SOMETHING</error>
</response>



Description of the errors


General API errors


General API errors
Code Description
E_CREDIT_EXPIRED Credit expired.
E_DENIED_IP The request is not accepted from the client's IP. Please contact Xminder's administrators.
E_KEY_DISABLED The value of the parameter key used in the request has been disabled. Please contact Xminder's administrators.
E_KEY_EMPTY The parameter key is missing from the request.
E_KEY_INVALID The value of the parameter key is invalid.
E_METHOD_INVALID Request to a module that does not exist in API.
E_NO_CREDIT Insufficient credit.
E_INTERNAL_X Internal error. Please contact Xminder's administrators and give them complete information about the error (E_INTERNAL_143, E_INTERNAL_345 or other).


API DATABASE errors


API DATABASE errors
Code Description
E_DATABASE_ACCESS_DENIED You don't have writing permission in this database.
E_DATABASE_ID The ID of the database table is invalid.
E_DATABASE_INVALID_EMAIL The email is not valid.
E_DATABASE_INVALID_FIELDS At least one of the [field's name] parameters does not match the fields in the database table.
E_DATABASE_INVALID_KEYWORD The keyword parameter is not valid.
E_DATABASE_NO_DATA No field is sent to be inserted.
E_DATABASE_TO_FIELD_MISSING The field for the alert message is missing.
E_DATABASE_INTERNAL Internal error of the module DATABASE. Please contact Xminder's administrators and give them complete information about the error (E_DATABASE_INTERNAL_121, E_DATABASE_INTERNAL_205 or other).



    ⇑ Top of page ⇐ Home    
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox