Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get the list of all the properties for a specific property manager.

Endpoint:

Status
colourGreen
titleget
https://ws.icnea.net/statistics_get_properties.aspx?usr=a1b2c3d4e5&client_id=1234

...

Parameter

...

Type

...

Description

...

usr

...

/analytics/listings/

Use this endpoint to retrieve all listings for a given property manager.

...

QUERY PARAMS

usr string required

API_key for your company, provided by Icnea.

client_id

integer required

Property Manager ID

...

exclude_active boolean

Set to true to return only unlisted listings. Default is false.

...

RESPONSES

Status
colourGreen
title200

Code Block
languagejson
{  
  "statisticsanalytics_get_propertieslistings_response": {
    "lodgingslistings": [
      {
        "lodginglisting_id": 12341001,
        "active": "true"
      }, {
        "lodginglisting_id": 12341002,
        "active": "false"
      }
    ] 
  }
}

ParameterField

Type

Description

lodginglisting_id

integer

Unique ID of the property. 5-digits (in testing accounts) or 8-digits (in real accounts).

active

boolean

True or false.

Status
colourRed
title400

Code Block
languagejson
{  
  "analytics_listings_response": {
    "error_code": "",
    "error_message": ""
  }
}

Field

Type

Description

error_code

string

Icnea internal error_id to help with debugging.

error_message

string

Human readable description of error.