GET 1.0/customermanagement/portals?countrycode={countrycode}&paymenttype={paymenttype}&includehidden={includehidden}

Description

Returns a list of active property portals

URI Parameters
Name Description Type Additional information
countryCode

ISO-2 country code of the property portals to return

 integer

Default value is -1
paymentType

Payment type of the property portals to return (0: free, 1: free with conditions, 2: pay per click, 3: monthly subscription)

 integer

Default value is -1
includeHidden

Indicates whether hidden property portals should be returned

 boolean

Default value is False

None.

None.

Collection of PropertyPortal
Name Description Type Additional information
Prefix

string

None.
Name

string

None.
Url

string

None.
PaymentType

byte

None.
LogoUrl

string

None.
CountryCode

integer

None.
Hidden

boolean

None.

application/json, text/json
Sample: 
[
  {
    "prefix": "sample string 1",
    "name": "sample string 2",
    "url": "sample string 3",
    "paymentType": 64,
    "logoUrl": "sample string 5",
    "countryCode": 6,
    "hidden": true
  },
  {
    "prefix": "sample string 1",
    "name": "sample string 2",
    "url": "sample string 3",
    "paymentType": 64,
    "logoUrl": "sample string 5",
    "countryCode": 6,
    "hidden": true
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertyPortal xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PropertyPortal>
    <Prefix>sample string 1</Prefix>
    <Name>sample string 2</Name>
    <Url>sample string 3</Url>
    <PaymentType>64</PaymentType>
    <LogoUrl>sample string 5</LogoUrl>
    <CountryCode>6</CountryCode>
    <Hidden>true</Hidden>
  </PropertyPortal>
  <PropertyPortal>
    <Prefix>sample string 1</Prefix>
    <Name>sample string 2</Name>
    <Url>sample string 3</Url>
    <PaymentType>64</PaymentType>
    <LogoUrl>sample string 5</LogoUrl>
    <CountryCode>6</CountryCode>
    <Hidden>true</Hidden>
  </PropertyPortal>
</ArrayOfPropertyPortal>