Operation is used to retrieve full details of given contact person id.
Token issued for API consumer.
Id of contact person
Contact Person
{
"Address": {
"address": {
"apartments": [
"http://example.com/api/v2/apartments/2424968/"
],
"buildingId": "",
"building_name": null,
"city": "MOST COMMON STREET",
"cityAlt": "",
"country": "",
"createdBy": "test user",
"createdTs": "2022-05-05T21:25:43.998Z",
"district": "",
"empty": 0,
"id": 29647850,
"listUrl": "http://example.com/api/v2/addresses/",
"location": "SRID=3067;POINT (674524.00220502 6934108.1091534)",
"municipality": "",
"propertyId": "",
"province": "",
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "TESTS",
"streetnameAlt": "",
"streetno": "2",
"subdivision": "",
"updatedBy": "test user",
"updatedTs": "2022-08-10T11:23:39.624Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": ""
},
"apartmentDivision": null,
"apartmentLetter": null,
"apartmentNumber": null,
"empty": 1,
"id": 2424968,
"listUrl": "/api/v2/apartments/",
"originProperty": "//0000001949546",
"originalStreetno": null,
"sourceSystem": null,
"sourceSystemKey": null,
"usagePurpose": null,
"usagePurposeAlt": null,
"usageState": null
},
"Role": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "CONTACT_ROLE",
"id": 27371,
"list_url": "http://example.com/api/v2/txt_constants/groupname/CONTACT_ROLE/",
"logical_txt": "Contact person",
"num_value": 0.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Yhteyshenkilö"
},
"comments": "Test contact person via contact person rest api",
"contact_person_restricted_type": null,
"contact_start_date": "2025-02-07",
"created_by": "test user",
"created_ts": "2025-07-25T14:34:26.013Z",
"customer_number": "ContactPerson123",
"email": "jdoe@us.ibm.com",
"fax": "490-521-0709",
"id": 127120,
"name": "John Doe",
"phone": "1234567890",
"phone2": "123-456-7890"
}A full representation of a Contact Person object, used for listing or retrieving contact person details.
Additional comments about the contact person.
Start date of the contact person.
User who created the contact person.
Timestamp when the contact person was created.
Customer number associated with the contact person.
Email address of the contact person.
Fax number of the contact person.
Unique identifier for the contact person.
Name of the contact person.
Primary phone number of the contact person.
Secondary phone number of the contact person.
Building id
Building name
Building city name
Building city name in alternative language
Building country
creator
Creation date and time
Building district
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Primary key
Geographical location
Building municipality
Property number
Building province
External source system
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
source system key
Building street name
Building street name in alternative language
Building number
Building municipality subdivision
Last updater
Last update date time
Building usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Address usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Building zipcode
apartment division
apartment letter
apartment number
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Primary key
apartment original property id
apartment original streen number
External source system
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
source system key
Apartment Usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Address usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Apartment status
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
URL to the list of contact persons.
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Detailed description of error
Object was not found
{
"details": "Not found."
}Detailed description of error