Contents x
    Get list of Junctions
    • 17 Jan 2024
    • 6 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get list of Junctions

    • Updated on 17 Jan 2024
    • 6 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /junctions/

    Operation is used to get a list of Junctions.

    Junctions data can be filtered by giving filtering parameters at HTTP querystring (see parameters).

    Security
    API Key
    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.

    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))+++
    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 the list if applicable. (Null if none)

    Prev
    string (url)

    Url to previous page of the list if applicable. (Null if none)

    Results
    Array of object (Junction)

    List of fetched Junctions

    object
    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

    Customer
    object (Customer)
    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

    Customer_language
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Customer_restricted_type
    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)

    Customer_state
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Customer_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Invoicing_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

    coop_date
    string (date)

    Cooperative date

    coop_member
    boolean

    If customer is a member of cooperative or not

    coop_reimburse_date
    string (date)

    Cooperative date of reimbursement

    coop_sum
    integer

    Sum of cooperative

    customer_country
    string

    Customer country

    customer_email
    string

    Customer email address GDPR protected field

    customer_name
    string

    Name of customer GDPR protected field

    customer_name_ext
    string

    Customer name extension GDPR protected field

    customer_number
    string

    Customer number

    customer_phone
    string

    Primary phone number GDPR protected field

    edited_by_customer_timestamp
    string (date-time)

    Customer modified date and time

    id
    integer

    Primary key

    identification
    string

    Identification of customer

    invoicing_country
    string

    Invoicing country

    invoicing_name
    string

    Invoice name GDPR protected field

    is_edited_by_customer
    boolean

    If editable by customer

    no_sms
    boolean

    If true sms sending is disabled otherwise, it is enabled

    note
    string

    Customer note or additional details

    phone2
    string

    Secondary phone number GDPR protected field

    two_sms_numbers
    boolean

    If using two SMS numbers or not

    vat_code
    string

    Personal/Business ID GDPR protected field

    water_db_id
    integer

    Water database id

    Maint_area
    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)

    Network
    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)

    State
    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)

    agreed_delivery
    string (date)

    Agreed delivery date

    building_room
    string

    Building or room

    comments
    string

    Comments or additional details

    connectivity_date
    string (date)

    Connectivity date

    contact_date
    string (date)

    Contact date

    contact_person1
    string

    First contact person

    contact_person2
    string

    Second contact person

    date_created
    string (date)

    Created date

    id
    integer

    Primary key

    junction_number
    string

    Junction number

    junction_power
    number (float)

    Junction power

    name
    string

    Name

    offer_accepted
    boolean

    Specifies if offer is accepted

    offer_accepted_date
    string (date)

    Offer accepting date

    offer_rejected
    boolean

    Specifies if offer is rejected

    offer_requested
    boolean

    Specifies if offer is requested

    offer_send_date
    string (date)

    Offer sending date

    offer_valid_until_date
    string (date)

    Offer valid until date

    proposed_delivery
    string (date)

    Proposed delivery date

    requested_delivery
    string (date)

    Requested delivery date

    restricted_type
    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)

    starting_date
    string (date)

    Starting date

    Total
    integer

    Total number of junction objects in the list

    401

    Authentication credentials are missing or invalid

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

    Detailed description of error

    Was this article helpful?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved