Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Create: HTTP POST /<entity type name>

  • Read: HTTP GET /<entity type name>/<entity id>.<format

  • Update: HTTP PUT /<entity type name>/<entity id>.<format>

  • Delete: HTTP DELETE /<entity type name>/<entity id>

...

Clients may use GET calls, to pull information from the system, including applying advanced filters and sorting.  Reference the Web Service Data Structures page for more information on each content type, their available fields, and accepted values. Most fields, including custom, are available to filter against. Multiple filters may be added to the query string via ampersands. The examples below detail common URL filter configurations.

Supported Operators

Operator

Syntax

Example

Result

>

[gt]=

user.json?uid[gt]='100'

All users with uids greater than (but not equal to) 100

>=

[ge]=

node.json?created[ge]='1478044800'

All nodes created after or equal to 11/02/2016 - 00:00 UTC

<

[lt]=

user.json?uid[lt]='500'

All users with uids less than (but not equal to) 500

<=

[le]=

user.json?login[le]='1478278815'

All users who have logged in before or equal to 11/04/2016 - 17:00 UTC

<>

[ne]=

credit_awarded.json?type[ne]='attendance'

All awarded credit that is not Attendance

=

[eq]=
OR =

credit_awarded.json?type[eq]='ama'
credit_awarded.json?type='ama'

All awarded AMA credit

Contains

[ct]=

user.json?mail[ct]='ethosce.com'

All users with an e-mail address which contains 'ethosce.com'

Starts with

[sw]=

user.json?name[sw]='jsmith'

All users who have a username that starts with 'jsmith'

Query Examples

Return all credit awarded to user 2, sorted by awarded date

...