API ASARI CRM

• Site
• MLS

Introduction

Api methods serve http calls responding with json (http://www.json.org/)

Main url: https://api.asari.pro 

Response format

Every response object has property:

• success (boolean) - determaining if response is valid or error occured.

Success Response

Json object with properties:

• data (object or array of objects)
• totalCount (integer) - returned if data is array and method enables pagination

Example simple object:

{
  success: true
  data: {
    id: 1
    propertyType: "House"
  }
}

Example list:

{
  success: true,
  data: [
    { id: 1, propertyType: "House"},
    { id: 2, propertyType: "Lot"},
    { id: 3, propertyType: "House"},
  ],
  totalCount: 140
}

Error Response

Json object with properties:

• error (string) - error message in human readable format (localized)
• parametersErrors (object where properties are names of parameters and values are error messages related to given parameter) - returned if error is related to input parameters. F.ex. can be used as error messages for forms submitted by user.

Example error:

{
  success: false,
  error: "You need to activate asariCRM to add tasks"
}

Example error with parameter errors:

{
  success: false,
  error: "Invalid input",
  parameterErrors : {
    email: "Invalid format",
    password: "Password to short"
  }
}

Return types

Method will return json object with following properties (more info http://www.json.org/ )

{ amount: (float),currency:(string)}

{ amount: 251 currency:"PLN"}

Dictionaries

Methods

• Required paremeters are marked with *
• If property is type of dictionary and both names are the same, name of dictionary is ommited f.ex. - sectionName(dictionary SectionName) -> sectionName(dictionary)
• Methods that raturn that don't return no data except of success indicator are marked as succces/failure