SearchAdapter Web Services

<back to all web services

PropertySearch

The following routes are available for this service:
GET/propertySearch for properties with sale history
PropertySearch Parameters:
NameParameterData TypeRequiredDescription
MaxNumberOfSalesPerBuildingqueryint?No
Search Parameters:
NameParameterData TypeRequiredDescription
QueryStringbodystringNo
ReturnAllContactPointsbodyboolNo
Rowsbodyint?No
Offsetbodyint?No
FiltersbodyList<string>No
FacetsbodyList<string>No
FieldsbodyList<string>No
SortBybodyList<string>No
ProfilebodystringNo
PropertySearchResponse Parameters:
NameParameterData TypeRequiredDescription
HitsbodyList<PropertyHit>No
SearchResponseBase Parameters:
NameParameterData TypeRequiredDescription
QueryTimeMilliSecondsbodyintNo
NumberOfHitsbodylongNo
ResponseStatusbodyResponseStatusNo
VersionbodystringNo
FacetsbodyList<Facet>No
ProfilebodystringNo
PropertyHit Parameters:
NameParameterData TypeRequiredDescription
ScorebodydoubleNo
PropertybodyPropertyNo

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

HTTP + JSV

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

POST /jsv/reply/PropertySearch HTTP/1.1 
Host: api-dev.1881.no 
Content-Type: text/jsv
Content-Length: length

{
	MaxNumberOfSalesPerBuilding: 0,
	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: text/jsv
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
					}
				],
				Sales: 
				[
					{
						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-01,
						DocumentNumber: 0,
						IncludesBuilding: False,
						NewsletterFormatText: String,
						IsHousingCooperative: False,
						GroupSaleId: String,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				],
				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-01
			}
		}
	],
	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
}