Rest - Work - Session Groups - Session Notes

From Views API Documentation
Jump to navigation Jump to search

Purpose

Used for creating, editing and deleting notes against a session record in the Views system.

Base URL

https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<id>/notes

Creating Sessions

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

If there is a problem with creating that record, you will get a response containing all the errors, plus a copy of the translated data you supplied.

If the record was created successfully, the service will return a complete reocrd for the newly created record if the attribute id set as the newly created id.

Searching for a Note

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will list all notes against a session

Fetching a Note

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will retreive a note from the views system.


Updating a Note

Please note You can only update session record notes via this api.

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
  • id - The ID of the session

The XML should be in the same format as the create, as specified by the schema

Deleting a Note

Please note You can only delete session record notes via this api.

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
  • id - The ID of the session

This should be used with great care as it will permanently delete a note record.