Agent Websites Properties Microservice

Base URL: /v1, Version: 1.0.0

Handles Agent Website Related Property Information

Schemes: http

Summary

Tag: MultilingualListing

Operation Description
GET /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Multilingual texts for a listing

938-888-0058

Titles for listings for language

(320) 296-9076

DescriptionsForSiteHomePage for listings for language

Tag: HomePageListings

Operation Description
POST /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Save multilingual texts for a property

DELETE /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Delete multilingual texts

(832) 700-1381

Home page listings for an agent

(214) 462-5043

Save home page listings for an agent

GET /homePageListings/withTexts/hostId/{hostId}/agentId/{agentId}/languageId/{languageId}

Home page listings for an agent with texts

DELETE /homePageListings/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Delete a homepage listing

Paths

Home page listings for an agent

GET /homePageListings/hostId/{hostId}/agentId/{agentId}

Tags: (508) 345-7691

Retrieves the home page listings for an agent with their slots.

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)

application/json

200 OK

An array of propertyIds and slots

data: object[]
object
propertyId: integer
positionOnSiteHomePage: integer
default

Unexpected error

Save home page listings for an agent

POST /homePageListings/hostId/{hostId}/agentId/{agentId}

Tags: HomePageListings

Saves the home page listings for an agent with their slots (all existing info is deleted).

object
slot: integer
propertyId: integer
hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)

text/html

200 OK

Successful update

default

Unexpected error

Delete a homepage listing

DELETE /homePageListings/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Tags: HomePageListings

Delete a homepage listing by propertyId

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
propertyId

Property identifier.

path number (integer)

text/html

200 OK

Successful delete

default

Unexpected error

Home page listings for an agent with texts

GET /homePageListings/withTexts/hostId/{hostId}/agentId/{agentId}/languageId/{languageId}

Tags: HomePageListings

Retrieves the home page listings for an agent with their texts for a given language.

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
languageId

Language identifier.

path number (integer)
limit

limit the number of listings (all if omitted).

query number (integer)

application/json

200 OK

An array of propertyIds and description texts

data: object[]
object
propertyId: integer
descriptionForSiteHomePage: string
default

Unexpected error

DescriptionsForSiteHomePage for listings for language

GET /multilingualListingInfo/descriptions/hostId/{hostId}/propertyIds/{propertyIds}/languageId/{languageId}

Tags: MultilingualListing

Retrieves the descriptionForSiteHomePage for a list of property ids for a given language

hostId

Identifier for the application that made the call.

path number (integer)
propertyIds

Property identifiers, comma delimited.

path string
languageId

Language identifier.

path number (integer)

application/json

200 OK

An array of propertyIds and the descriptionForSiteHomePage for each

data: object[]
object
propertyId: integer
descriptionForSiteHomePage: string
default

Unexpected error

Delete multilingual texts

DELETE /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Tags: 2012990676

Delete multilingul texts for a property for all languages

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
propertyId

Property identifier.

path number (integer)

text/html

200 OK

Successful delete

default

Unexpected error

Multilingual texts for a listing

GET /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Tags: 4502407621

Retrieves all the multilingual texts records for a property

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
propertyId

Property identifier.

path number (integer)

application/json

200 OK

An array of propertyIds and multilingual texts (title & description)

data: object[]
object
languageId: integer
titleForSite: string
descriptionForSiteHomePage: string
default

Unexpected error

Save multilingual texts for a property

POST /multilingualListingInfo/hostId/{hostId}/agentId/{agentId}/propertyId/{propertyId}

Tags: HomePageListings

Saves the home page listings for an agent with their slots (all existing info is deleted).

object
languageId: integer
title: string
description: string
hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
propertyId

Property identifier.

path number (integer)

text/html

200 OK

Successful update

default

Unexpected error

Titles for listings for language

GET /multilingualListingInfo/titles/hostId/{hostId}/agentId/{agentId}/propertyIds/{propertyIds}/languageId/{languageId}

Tags: MultilingualListing

Retrieves titles for a list of property ids for a given language

hostId

Identifier for the application that made the call.

path number (integer)
agentId

Agent identifier.

path number (integer)
propertyIds

Property identifiers, comma delimited.

path string
languageId

Language identifier.

path number (integer)

application/json

200 OK

An array of propertyIds and titles

data: object[]
object
propertyId: integer
titleForSite: string
default

Unexpected error

Schema definitions

Error: object

code: integer (int32)
message: string