INRIX documentation logo

Retrieves the requested reference schema from a specified geography. The reference schema includes information such as segment Ids, names, lengths, ref speed and connectivity info to adjacent segments.

Note: This information only changes when the underlying map data changes. This happens infrequently. The API only needs to be called when the data changes, usually once per Map Update. Contact your INRIX account representative to understand when this change happens.

/?Action=GetReferenceSchemaInGeography

GET Retrieves segments for a specified rectangular region.

Parameters

  = required
Name Located In Type Description
Token Query String A valid authorization token returned in response to a GetSecurityToken request.
GeoId Query String The ID of the specified geography. For more information on how to obtain the ID, see GetGeography. When using a custom GeoId (previously created with CreateGeography), the first call will create cached files. Once these have been created the call will return the correct information.
LOCRefMethod Query String This parameter specifies which location referencing method is to be used in the Reference Schema to describe the geography of the elements.
Value Description
OPENLR Returns OpenLR location referencing. This is the default.

Notes

  1. If the geography is too large, this call will fail with a statusId of 459 and a statusText of “Data too large”.
  2. The length values are returned in meters.
  3. Most segments include a standard OpenLR, tisaOpenLR and location reference info including Functional Road Class, Form of Way and bearing. There are some segments where an OpenLR string cannot be created or might be decoded incorrectly due to map data inconsistancies and in these cases, the lat/lon values for the start and end points are provided instead of the LocationReference info.


Requests

Example GetReferenceSchemaInGeography Request
Query
http://{serverPath}.INRIX.com/...?Action=GetReferenceSchemaInGeography&Token={token}&GeoId=15&LOCRefMethod=OPENLR

Responses

200 Success
<Inrix docType="GetReferenceSchemaInGeography" copyright="Copyright INRIX Inc." versionNumber="11.0" createdDate="2017-10-18T23:56:45Z" statusId="0" statusText="" responseId="bdf3c390-766b-4454-9dc6-e1ee75a7d7a3">
  <Dictionary xmlns="http://www.INRIX.com/LocDictionary" xmlns:tdt="http://www.tisa.org/TPEG/TPEGDataTypes_2_0" xmlns:olr="http://www.tisa.org/TPEG/OLR_1_0">
    <Report dictionaryUpdateDateTime="2017-09-19T01:21:04" dictionaryVersion="17.2">
        <reportSegments>
            <ReportSegmentID>1263038356</ReportSegmentID>
            <ReportSegmentLRC>
                <method>
                    <olr:version>1.0</olr:version>
                    <olr:locationReference>
                        <olr:optionLinearLocationReference>
                            <olr:first>
                                <olr:coordinate><olr:longitude>-3345252</olr:longitude><olr:latitude>1937573</olr:latitude></olr:coordinate>
                                <olr:lineProperties>
                                    <olr:frc olr:table="olr001_FunctionalRoadClass" olr:code="3"/>
                                    <olr:fow olr:table="olr002_FormOfWay" olr:code="3"/>
                                    <olr:bearing><olr:value>178</olr:value></olr:bearing>
                                </olr:lineProperties>
                                <olr:pathProperties>
                                    <olr:lfrcnp olr:table="olr001_FunctionalRoadClass" olr:code="3"/>
                                    <olr:dnp><olr:value>2353</olr:value></olr:dnp>
                                    <olr:againstDrivingDirection>false</olr:againstDrivingDirection>
                                </olr:pathProperties>
                            </olr:first>
                            <olr:last>
                                <olr:coordinate><olr:longitude>-2592</olr:longitude><olr:latitude>11</olr:latitude></olr:coordinate>
                                <olr:lineProperties>
                                    <olr:frc olr:table="olr001_FunctionalRoadClass" olr:code="3"/>
                                    <olr:fow olr:table="olr002_FormOfWay" olr:code="3"/>
                                    <olr:bearing><olr:value>73</olr:value></olr:bearing>
                                </olr:lineProperties>
                            </olr:last>
                            <olr:positiveOffset><olr:value>871</olr:value></olr:positiveOffset>
                            <olr:negativeOffset><olr:value>738</olr:value></olr:negativeOffset>
                        </olr:optionLinearLocationReference>
                    </olr:locationReference>
                </method>
            </ReportSegmentLRC>
            <LinearConnectivity>
                <negLink><ReportSegmentID>1263090572</ReportSegmentID></negLink>
                <posLink><ReportSegmentID>1263038390</ReportSegmentID></posLink>
            </LinearConnectivity>
            <SegmentNames>
                <Name>Beach Pond Rd|CT-165|Route 165</Name>
            </SegmentNames>
            <segmentLength>744</segmentLength>
            <segmentRefSpeed>0</segmentRefSpeed>
            <openLR>C8z0nB2QpRt2KPXgAAsbaV5Q</openLR>
            <tisaOpenLR>CCsBEAAnJsz0nB2QpQAJBQQDA7IACgUEA5IxAPXgAAsACQUEAwNJADCGZ4Vi</tisaOpenLR>
        </reportSegments>
        <reportSegments>
            <ReportSegmentID>1263231739</ReportSegmentID>
            <coordinates>
                <start><latitude>41.3908462524414</latitude><longitude>-71.8341522216797</longitude></start>
                <end><latitude>41.3971481323242</latitude><longitude>-71.8287582397461</longitude></end>
            </coordinates>
            <LinearConnectivity><negLink><ReportSegmentID>1263220586</ReportSegmentID></negLink></LinearConnectivity>
            <SegmentNames><Name>Canal St</Name></SegmentNames>
            <segmentLength>921</segmentLength>
            <segmentRefSpeed>0</segmentRefSpeed>
            <openLR>C8zq/R1u+TPfBQAeARMzEg==</openLR>
            <tisaOpenLR>CCcBEAAjIszq/R1u+QAJBQQGA/cACgUEBoI9AAAeARMACQUEBgOUAAA=</tisaOpenLR>
        </reportSegments>
    </Report>
  </Dictionary>
</Inrix>