SearchAdapter Web Services

<back to all web services

SinglePropertySaleSearch

The following routes are available for this service:
GET/property/saleSearch for sales of properties
Search Parameters:
NameParameterData TypeRequiredDescription
QueryStringbodystringNo
ReturnAllContactPointsbodyboolNo
Rowsbodyint?No
Offsetbodyint?No
FiltersbodyList<string>No
FacetsbodyList<string>No
FieldsbodyList<string>No
SortBybodyList<string>No
ProfilebodystringNo
SinglePropertySaleSearchResponse Parameters:
NameParameterData TypeRequiredDescription
HitsbodyList<SinglePropertySaleHit>No
SearchResponseBase Parameters:
NameParameterData TypeRequiredDescription
QueryTimeMilliSecondsbodyintNo
NumberOfHitsbodylongNo
ResponseStatusbodyResponseStatusNo
VersionbodystringNo
FacetsbodyList<Facet>No
ProfilebodystringNo
SinglePropertySaleHit Parameters:
NameParameterData TypeRequiredDescription
ScorebodydoubleNo
PropertybodySinglePropertySaleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/SinglePropertySaleSearch HTTP/1.1 
Host: api-dev.1881.no 
Content-Type: application/json
Content-Length: length

{"QueryString":"String","ReturnAllContactPoints":false,"Rows":0,"Offset":0,"Filters":["String"],"Facets":["String"],"Fields":["String"],"SortBy":["String"],"Profile":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Hits":[{"Score":0,"Property":{"Id":"String","Type":"String","BuildingId":"String","BuildingType":"String","StreetAddress":{"MunicipalityCode":"String","Municipality":"String","PostalCode":"String","PostalArea":"String","Country":"String","StreetName":"String","HouseNumber":"String","HouseLetter":"String","AddressText":"String","CityArea":"String","CitySector":"String","TradeArea":"String","TradeAreaId":0,"County":"String","Region":"String","Coordinate":{"Latitude":0,"Longitude":0},"Values":[{"Key":"String","Value":"String","Type":"String"}]},"Values":[{"Key":"String","Value":"String","Type":"String"}],"Sale":{"Type":"String","Id":0,"LineId":0,"Price":0,"Buyers":[{"Id":"String","Name":"String","IsCompany":false,"Percentage":0,"Values":[{"Key":"String","Value":"String","Type":"String"}]}],"Sellers":[{"Id":"String","Name":"String","IsCompany":false,"Percentage":0,"Values":[{"Key":"String","Value":"String","Type":"String"}]}],"InfoText":"String","SoldDate":"0001-01-01T00:00:00.0000000","DocumentNumber":0,"IncludesBuilding":false,"NewsletterFormatText":"String","IsHousingCooperative":false,"GroupSaleId":"String","Values":[{"Key":"String","Value":"String","Type":"String"}]},"Coordinate":{"Latitude":0,"Longitude":0},"DataSource":[0],"Whatever":"String","DisplayValues":[{"Key":"String","Value":"String","Type":"String"}],"SearchTerms":[{"Key":"String","Value":"String","Type":"String"}],"Contexts":[[{"Key":"String","Value":"String","Type":"String"}]],"FullReservation":["String"],"ConfigVersion":"String","LastUpdated":"0001-01-01T00:00:00.0000000"}}],"QueryTimeMilliSeconds":0,"NumberOfHits":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"Version":"String","Facets":[{"Type":"String","Values":[{"Value":"String","FilterValue":"String","Count":0}]}],"Profile":"String"}