Get contact person connection data details
  • 17 Jan 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get contact person connection data details

  • Dark
    Light
  • PDF

Article summary

Get
/contact-person-connections/{id}/

Operation retrieves full details by given id.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of contact person connection

Responses
200

Contact Person Connection

Expand All
object
Contact
object (ContactPerson)
Address
object (Apartment)
address
object (Address)
buildingId
string

Building id

city
string

Building city name

cityAlt
string

Building city name in alternative language

country
string

Building country

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

district
string

Building district

id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

streetname
string

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

Building number

subdivision
string

Building municipality subdivision

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usagePurpose
object (BuildingUsage)

Building usage purpose

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

zipcode
string

Building zipcode

apartmentDivision
string

apartment division

apartmentLetter
string

apartment letter

apartmentNumber
string

apartment number

id
integer

Primary key

originProperty
string

apartment original property id

originalStreetno
string

apartment original streen number

usagePurpose
object (ApartmentUsage)

Apartment Usage purpose

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usageState
object (ApartmentStatus)

Apartment status

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

ContactPersonRestictedType
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

Role
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

comments
string

Comments or additional details

contact_start_date
string (date)

Contact start date

created_by
string

Username of contact person creator

created_ts
string (date)

Date of creation

customer_number
string

Customer number

email
string

Email address GDPR protected field

fax
string

Fax number GDPR protected field

id
integer

Primary key

name
string

Contact person name GDPR protected field

phone
string

Primary phone number GDPR protected field

phone2
string

Secondary phone number GDPR protected field

Object
integer

Connected object id

id
integer

Primary key

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?