Specifications

Action

Description

GET

Read, Search:

Use GET when you want to read resources. Search criteria is applied using paramsJSON.

PUT

Create, or Fully Update/Replace:

Use PUT when you want to modify a record that exists. PUT replaces the record in its entirety. If the record sent doesn't exist, our PUT will automatically POST. Please note, any excluded properties insert as null.

PATCH

Partial Update:

Use PATCH when you want to modify part of an existing record. Just send what's needed. Excluded properties are ignored.

GET, search records using paramsJson

General format: /resource?paramsJson={“property”:[“value”]}

  • You may omit quotations around certain value types. For simplicity, quotations are accepted around all value types.

OR values:
returns the resources that have the property with value1 OR value2 OR value3, etc...

  • {“property”:[“value1","value2","value3",...]}

AND properties:
returns the resources that have the property1 AND the property2, with their respective values.

  • {"property1":["value"],"property2":["value"]}

Dates:

  • Quotations are required around value: ["value"]

  • Accepts

    • exact match: {"dateProperty": ["yyyy-mm-dd hh:mm:ss.sss"]}

    • between: {"dateProperty": ["from=yyyy-mm-dd&to=yyyy-mm-dd"]}

    • greater than: {"dateProperty": ["from=yyyy-mm-dd"]}

    • less than: {"dateProperty": ["to=yyyy-mm-dd"]}

Text, string, nvarchar:

  • Quotations are required around value: ["value"]

  • Accepts:

    • exact match: {"textProperty": ["value"]}

    • contains: {"textProperty": ["contains=value"]}

    • starts with: {"textProperty": ["startswith=value"]}

    • ends with: {"textProperty": ["endswith=value"]}

Boolean:

  • Quotations are optional around value: [value] or ["value"]

  • Accepts: True, False

Int, decimal:

  • Quotations are optional around a single value, but are required if using a range operation: [value] or ["value"]

  • Accepts:

    • exact match: {"decimalProperty": [value]}

    • between: {"decimalProperty": ["from=value&to=value"]}

    • greater than: {"decimalProperty": ["from=value"]}

    • less than: {"decimalProperty": ["to=value"]}

PUT, create/replace records

Content-Type: application/json
Body:

  • Creates new records if no {resource}ID is sent.

  • Replaces the existing record if the {resource}ID sent is found.

    • Errors if {resource}ID is sent, but is not found.

  • "Names” should not be NULL.

  • Properties not sent, will update to NULL.

  • Properties sent with NULL, will update to NULL.

  • Expects an array or records for the resource:

    • single record update [{....}]

    • multi record update [{....},{....}]
      When sending multiple records, only the first is inserted.
      Use the response to remove the successfully inserted record
      from your succeeding payload.

PATCH, update records

Content-Type: application/json

Body:

  • Updates the existing record if the {resource}ID sent is found.

    • Errors if {resource}ID is not sent, or is sent but is not found.

  • "Names” should not be Null.

  • Properties not sent, will not update.

  • Properties sent with NULL, will update to NULL.

  • Expects an array of records for the resource:

    • single record update [{....}]

    • multi record update [{....},{....}]
      When sending multiple records, only the first is inserted.
      Use the response to remove the successfully inserted record
      from your succeeding payload.