The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Hits:
[
{
Score: 0,
Role:
{
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
}
]
}
]
}
}
}
}
],
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
}