Get list of Contact Persons.

  • 6 minute(s) read
Prev Next
Get
/contact-persons/

Operation is used to get a list of Contact Persons.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Query parameters
offset
integer

Offset to start returning results.

Minimum0
limit
integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1
__any of the object fields__
string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

  • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
  • For numerics: gt, lt, gte, lte, isnull
  • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++
orderby
string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses
200

A result response object.

Expand All
object
Next
string (url)

Url to next page of contact persons. Null if No next page exist

Prev
string (url)

Url to previous page of contact persons. Null if No previous page exist

Results
Array of object (ContactPerson)

List of fetched contact persons

object

A full representation of a Contact Person object, used for listing or retrieving contact person details.

comments
string

Additional comments about the contact person.

contact_start_date
string (date)

Start date of the contact person.

created_by
string

User who created the contact person.

created_ts
string (date-time)

Timestamp when the contact person was created.

customer_number
string

Customer number associated with the contact person.

email
string (email)

Email address of the contact person.

fax
string

Fax number of the contact person.

id
integer

Unique identifier for the contact person.

name
string

Name of the contact person.

phone
string

Primary phone number of the contact person.

phone2
string

Secondary phone number of the contact person.

Address
object (Apartment)
address
object (Address)
buildingId
string

Building id

buildingName
string

Building name

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

empty
integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

sourceSystem
object (SourceSystem)

External source system

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

sourceSystemKey
integer

source system key

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

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

zipcode
string

Building zipcode

apartmentDivision
string

apartment division

apartmentLetter
string

apartment letter

apartmentNumber
string

apartment number

empty
integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

originProperty
string

apartment original property id

originalStreetno
string

apartment original streen number

sourceSystem
object (SourceSystem)

External source system

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

sourceSystemKey
integer

source system key

usagePurpose
object (ApartmentUsage)

Apartment Usage purpose

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

usageState
object (ApartmentStatus)

Apartment status

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Role
object (TxtConstant)
availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname
string

Group name of constant

id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

contact_person_restricted_type
object (TxtConstant)
availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname
string

Group name of constant

id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

list_url
string (uri)

URL to the list of contact persons.

Total
integer

Total number of contact persons

401

Authentication credentials are missing or invalid

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

Detailed description of error