LightBox ID Lookup Documentation

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Purpose

The purpose of this service is to allow a end user to pass in a LightBox ID from any of our core objects and return a reference back to the base object.

OAS 3.1 Specification

Features

Returns the type of LightBox Object
Returns a reference to the base object that is assigned this LightBox ID
Returns the location information of the base object that is assigned this LightBox ID

Requirements

The LightBox APIs are hosted in the cloud and therefore have no platform requirements. Application requirements include:

A network connection to the LightBox API server
Ability to parse JavaScript Object Notation (JSON) API responses
Secure HTTPS connection
LightBox authentication key
LightBox authentication key

Connecting your account

When your LightBox user account is created, a unique API key is also generated. The API key should be kept secret at all times and can only be used for API requests. The key is required in all API calls.

To retrieve your unique API key:

Log in to the LightBox Developer Portal
Select Apps from the menu bar
In your approved App, note your API key (under Consumer Key)

Performing API requests

All API requests must be made over secure HTTPS connections. Requests made over HTTP will fail.

The base URL of the API server that all API requests will be made to is: https://api.lightboxre.com/ followed by a version number https://api.lightboxre.com/v1

Authentication

LightBox APIs uses a token-based authentication. All requests to the LightBox APIs must be authenticated. The token to be passed via an HTTP header with key 'x-api-key' and value <Your authentication token>

Pass your unique API key in the authorization header of every LightBox API call. LightBox uses this information to authenticate your identify and determine whether you have sufficient permissions to complete the operation. curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/

API Requests

Query by LightBox ID

GET /lightboxid/{countryCode}/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/lightboxid/us/0201MABNPDBU5D2EGP08YA

https://api.lightboxre.com/v1/lightboxid/us/0201MABNPDBU5D2EGP08YA

Parameters

Parameter	Type	Description	Usage
id	path	Any LightBox ID from a LightBox Core Object	required
countryCode	path	Country code	required

Response

Media type: application/json

API Response

For each endpoint other then the tile requests the response will stay consistent.

{
  "$ref": "string",
  "$metadata": {
    "geogcs": {
      "epsg": "4362"
    },
    "recordSet": {
      "totalRecords": 99,
      "bbox": {
        "xMax": -105.250409,
        "xMin": -105.251916,
        "yMax": 40.023629,
        "yMin": 40.022576
      }
    }
  },
  "lightboxrefs": [
    {
      "$ref": "http://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99",
      "id": "0306F25KSXL0JZ4RTLPP99",
      "version": "v1",
      "type": "assessment",
      "location": {
        "streetAddress": "23143 CHERRY AVE",
        "locality": "LAKE FOREST",
        "regionCode": "CA",
        "postalCode": "92630",
        "postalCodeExt": "4537",
        "countryCode": "US",
        "representativePoint": {
          "longitude": -117.687713,
          "latitude": 33.627483,
          "geometry": {
            "wkt": "POINT(-117.687713 33.627483)"
          }
        },
        "geometry": {
          "wkt": "POINT(-117.687713 33.627483)"
        }
      },
       "parcels": [
        {
           "$ref": "http://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99",
          "id": "0306F25KSXL0JZ4RTLPP99"
        }
      ],
      "assessments": [
        {
           "$ref": "http://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99",
          "id": "0306F25KSXL0JZ4RTLPP99"
        }
      ],
       "structures": [
        {
           "$ref": "http://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99",
          "id": "0306F25KSXL0JZ4RTLPP99"
          "isPrimary": true
        }
      ],
       "addresses": [
        {
           "$ref": "http://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99",
          "id": "0306F25KSXL0JZ4RTLPP99"
        }
      ],
    }
  ]
}

See: OAS 3.1 Specification

HTTP Error Codes

HTTP Response status codes along with a brief summary of their commonly accepted usage. These status codes are returned by LightBox APIs for each request:

200	The request succeeded.
201	The object was created successfully
202	Accepted, no content
204	Successful, no content
204	The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. Typically returned on a DELETE
400	One or more of the request parameters were invalid.
401	The client must authenticate itself to get the requested response. *Note:* This could also be due to your trial key has expired.
404	The server cannot find the requested resource. This can also mean that the endpoint is valid but the resource itself does not exist.
429	Too many requests were made in a short period of time, or you have exceeded your request-lot pool.
500	The server has encountered an error it does not know how to handle.
503	Service Unavailable.

Was this article helpful?

What's Next

LightBox ID Lookup Release Notes

Table of contents

Purpose
API Requests
API Response
HTTP Error Codes