API Conventions

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

LightBox APIs follow a few API conventions.

Casing

Endpoint

Endpoints will be in all lower case letters.

Example:

http://api.lightboxre.com/v1/parcels/us/02030405696804

Path Parameters

All path parameters are case insensitive

Request Parameter Names

Request parameter names are camel case.

Example:

http://api.lightboxre.com/v1/parcels/us/geometry?wkt=POINT (-119.0602628 35.3590100000001)&bufferUnit=mi&bufferDistance=1

Request Parameter Values

If a request parameter value is an enumerator defined within the OAS specification then the values must match what is in the definition. These are typically in lower case. They are case sensitive.

Example:

http://api.lightboxre.com/v1/parcels/us/geometry?wkt=POINT (-119.0602628 35.3590100000001)&bufferUnit=mi&bufferDistance=1

Was this article helpful?

What's Next

Supported HTTP Methods/Verbs

Table of contents

Casing