SearchAdapter Web Services

PhoneSearch

The following routes are available for this service:
GET	/phonenumber/{QueryString}	Phonenumbersearch for persons and companies

**Search** Parameters:
Name	Parameter	Data Type	Required
QueryString	body	string	No
ReturnAllContactPoints	body	bool	No
Rows	body	int?	No
Offset	body	int?	No
Filters	body	List<string>	No
Facets	body	List<string>	No
Fields	body	List<string>	No
SortBy	body	List<string>	No
Profile	body	string	No

**UnitSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Hits	body	List<UnitHit>	No

**SearchResponseBase** Parameters:
Name	Parameter	Data Type	Required
QueryTimeMilliSeconds	body	int	No
NumberOfHits	body	long	No
ResponseStatus	body	ResponseStatus	No
Version	body	string	No
Facets	body	List<Facet>	No
Profile	body	string	No

**UnitHit** Parameters:
Name	Parameter	Data Type	Required
Score	body	double	No
Person	body	Person	No
Company	body	Company	No
Reserved	body	bool	No

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/PhoneSearch HTTP/1.1 
Host: api-dev.1881.no 
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	Hits: 
	[
		{
			Score: 0,
			Person: 
			{
				Id: String,
				Firstname: String,
				Middlename: String,
				Lastname: String,
				Gender: String,
				Birthdate: 0001-01-01,
				ContactPoints: 
				[
					{
						Name: String,
						Label: String,
						Value: String,
						Type: String,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: 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
						}
					]
				},
				PostalAddress: 
				{
					PostalArea: String,
					PostalCountry: String,
					PostalCode: String,
					Value: String,
					PostOffice: String,
					Number: String
				},
				Values: 
				[
					{
						Key: String,
						Value: String,
						Type: String
					}
				],
				Groups: 
				[
					{
						TopNode: 
						{
							ContactPoint: 
							{
								Name: String,
								Label: String,
								Value: String,
								Type: String,
								Values: 
								[
									{
										Key: String,
										Value: String,
										Type: String
									}
								]
							},
							Children: 
							[
								{
									ContactPoint: 
									{
										Name: String,
										Label: String,
										Value: String,
										Type: String,
										Values: 
										[
											{
												Key: String,
												Value: String,
												Type: String
											}
										]
									},
									Children: 
									[
										{
											ContactPoint: 
											{
												Name: String,
												Label: String,
												Value: String,
												Type: String,
												Values: 
												[
													{
														Key: String,
														Value: String,
														Type: String
													}
												]
											},
											Children: 
											[
												{
													
												}
											]
										}
									]
								}
							]
						},
						Id: 0,
						IsMainGroup: False
					}
				],
				Relations: 
				[
					{
						Direction: String,
						Name: String,
						Id: String,
						Type: String,
						Target: 
						{
							HasLink: False,
							Id: String,
							Type: String,
							Values: 
							[
								{
									Key: String,
									Value: String,
									Type: String
								}
							]
						},
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				]
			},
			Company: 
			{
				Id: String,
				Name: String,
				CompanyCode: String,
				Industries: 
				[
					{
						Code: String,
						Name: String,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				],
				ContactPoints: 
				[
					{
						Name: String,
						Label: String,
						Value: String,
						Type: String,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: 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
					}
				],
				OpeningHours: 
				[
					{
						Days: 
						[
							{
								DayOfWeek: String,
								OpenHhmm: 0,
								CloseHhmm: 0
							}
						],
						Text: String
					}
				],
				LegalInformation: 
				{
					LegalName: String,
					CompanyType: String,
					CommonName: 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
							}
						]
					},
					PostalAddress: 
					{
						PostalArea: String,
						PostalCountry: String,
						PostalCode: String,
						Value: String,
						PostOffice: String,
						Number: String
					},
					VisitorAddress: 
					{
						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
						}
					],
					FoundedDate: 0001-01-01,
					NaceIndustries: 
					[
						{
							Code: String,
							Name: String,
							Values: 
							[
								{
									Key: String,
									Value: String,
									Type: String
								}
							]
						}
					]
				},
				PostalAddress: 
				{
					PostalArea: String,
					PostalCountry: String,
					PostalCode: String,
					Value: String,
					PostOffice: String,
					Number: String
				},
				KeyFigures: 
				[
					{
						Year: 0,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				],
				Shareholders: 
				[
					{
						Type: String,
						Id: String,
						BirthDate: 0001-01-01,
						CompanyCode: String,
						Country: String,
						Name: String,
						UnitId: String,
						Ownership: 0,
						RefValue: String,
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				],
				Relations: 
				[
					{
						Direction: String,
						Name: String,
						Id: String,
						Type: String,
						Target: 
						{
							HasLink: False,
							Id: String,
							Type: String,
							Values: 
							[
								{
									Key: String,
									Value: String,
									Type: String
								}
							]
						},
						Values: 
						[
							{
								Key: String,
								Value: String,
								Type: String
							}
						]
					}
				],
				Groups: 
				[
					{
						TopNode: 
						{
							ContactPoint: 
							{
								Name: String,
								Label: String,
								Value: String,
								Type: String,
								Values: 
								[
									{
										Key: String,
										Value: String,
										Type: String
									}
								]
							},
							Children: 
							[
								{
									ContactPoint: 
									{
										Name: String,
										Label: String,
										Value: String,
										Type: String,
										Values: 
										[
											{
												Key: String,
												Value: String,
												Type: String
											}
										]
									},
									Children: 
									[
										{
											ContactPoint: 
											{
												Name: String,
												Label: String,
												Value: String,
												Type: String,
												Values: 
												[
													{
														Key: String,
														Value: String,
														Type: String
													}
												]
											},
											Children: 
											[
												{
													
												}
											]
										}
									]
								}
							]
						},
						Id: 0,
						IsMainGroup: False
					}
				],
				Person: 
				{
					Id: String,
					Firstname: String,
					Middlename: String,
					Lastname: String,
					Gender: String,
					Birthdate: 0001-01-01,
					ContactPoints: 
					[
						{
							Name: String,
							Label: String,
							Value: String,
							Type: String,
							Values: 
							[
								{
									Key: String,
									Value: String,
									Type: 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
							}
						]
					},
					PostalAddress: 
					{
						PostalArea: String,
						PostalCountry: String,
						PostalCode: String,
						Value: String,
						PostOffice: String,
						Number: String
					},
					Values: 
					[
						{
							Key: String,
							Value: String,
							Type: String
						}
					],
					Groups: 
					[
						{
							TopNode: 
							{
								ContactPoint: 
								{
									Name: String,
									Label: String,
									Value: String,
									Type: String,
									Values: 
									[
										{
											Key: String,
											Value: String,
											Type: String
										}
									]
								},
								Children: 
								[
									{
										ContactPoint: 
										{
											Name: String,
											Label: String,
											Value: String,
											Type: String,
											Values: 
											[
												{
													Key: String,
													Value: String,
													Type: String
												}
											]
										},
										Children: 
										[
											{
												ContactPoint: 
												{
													Name: String,
													Label: String,
													Value: String,
													Type: String,
													Values: 
													[
														{
															Key: String,
															Value: String,
															Type: String
														}
													]
												},
												Children: 
												[
													{
														
													}
												]
											}
										]
									}
								]
							},
							Id: 0,
							IsMainGroup: False
						}
					],
					Relations: 
					[
						{
							Direction: String,
							Name: String,
							Id: String,
							Type: String,
							Target: 
							{
								HasLink: False,
								Id: String,
								Type: String,
								Values: 
								[
									{
										Key: String,
										Value: String,
										Type: String
									}
								]
							},
							Values: 
							[
								{
									Key: String,
									Value: String,
									Type: String
								}
							]
						}
					]
				}
			},
			Reserved: False
		}
	],
	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
}