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>

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

JSON and XML are fully the supported "formats" for sending and receiving data.

...

Code Block
languagenone
https://client.hosted.test.cloud.ethosce.com/course_credit_awarded.xml?type[ne]=ama

Payload manipulation

The default for payload structure is to load the full field values for the first level of simple field types (text, select boxes, radio buttons, etc). More complex field types like the field collections (Profile Boards) or entity references (Course ACCME Data), will display a reference to that additional data type. Additionally, you can limit data returned to shrink returned payload size.

For more, please see Payload Manipulation.

Date Formatting

There are 2 date formats used when interacting with the web service, epoch and ISO 8601. The format used is dependent on what piece of data you wish to reference, usually either a property or a field. Additionally, both date formats must be converted to UTC before being sent, to ensure data integrity between systems.

...