Snip/SUID REST Callback

From Sni.ps Documentation

Jump to: navigation, search
   The functionality specified for the Snip/SUID Callback is documented but not yet implemented.


Contents

REST Callbacks

snip/{suid}

By default this is the callback for returning details on a single snip, but if posted to it is also the callback for editing or removing a snip.

View

No options need to be passed in to this callback.

Edit

For editing a snip, all arguments must be passed in via POST.

Required Arguments

action

The action being performed. For the action of editing a snip, this is set to edit. Default: null Options: edit and delete Example: action=edit

auth

The authentication key returned from identifying with oauth.

Optional Arguments

tag

For the edit action only. If set, the new tags overwrite the previous tags. If set with no tags, removes all tags from the snip. Default: null Example: tag=cat Example: tag=rock,banjo Example: tag= - This would remove all tags from the snip

title

For the edit action only. If set, the new title overwrites the previous title. If set with no title, sets the title of the snip to be blank. Default: null Example: title=The%20Incredible%20Edible Example: title= - This would set the title of the snip to be blank

note

For the edit action only. If set, the new note overwrites the previous note. If set with no note, sets the note of the snip to be blank. Default: null Example: note=This%20is%20your%20brain%20on%20drugs Example: note= - This would set the note of the snip to be blank

Remove

For removing a snip, all arguments must be passed in via POST.

Required Arguments

action

The action being performed. For the action of removing a snip, this is set to remove. Default: null Options: edit and delete Example: action=remove

auth

The authentication key returned from identifying with oauth.

Personal tools