GetFamilyInfo - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Geocoding > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial
Enterprise Geocoding
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum > Quality > Addressing
Spectrum > Web Services
Spectrum > Spectrum Platform
Spectrum > Quality > Context Graph
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-06-03
ft:lastPublication
2024-06-03T16:02:19.077100
Takes an input Precisely ID and returns the parent Precisely ID and the number of children/siblings Precisely IDs
  • Precisely ID input returns the parent Precisely ID and the total number of children/siblings Precisely IDs.

Resource URL

JSON endpoint:

https://OnDemandServer/rest/GetFamilyInfo/results.json
https://OnDemandServer/rest/GetFamilyInfo?_wadl

XML endpoint:

https://OnDemandServer/rest/GetFamilyInfo/results.xml
https://OnDemandServer/rest/GetFamilyInfo?_wadl

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example with JSON Response

The following example requests a JSON response:

https://spectrum.precisely.com/rest/GetFamilyInfo/results.json?Data.PreciselyID=P00002T21ESU

The JSON returned by this request would be:

{
    "Output": [
        {
            "ChildCount": 111,
            "ParentPreciselyID": "P00002T4TFZN",
            "PreciselyID.Input": "P00002T21ESU",
            "user_fields": []
        }
    ]
}

Example with XML Response

The following example requests an XML response:

https://spectrum.precisely.com/rest/GetFamilyInfo/results.xml?Data.PreciselyID=P00002T21ESU

The XML returned by this request would be:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xml.GetFamilyInfoResponse xmlns="http://www.pb.com/spectrum/services/GetFamilyInfo">
    <Output>
        <Row>
            <ChildCount>111</ChildCount>
            <ParentPreciselyID>P00002T4TFZN</ParentPreciselyID>
            <PreciselyID.Input>P00002T21ESU</PreciselyID.Input>
            <user_fields/>
        </Row>
    </Output>
</xml.GetFamilyInfoResponse>