User/UID/client REST Callback

From Sni.ps Documentation

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


Contents

REST Callbacks

user/{uid}/client

Returns a list of all external clients associated with a user.

Search

Optional Arguments

limit

The maximum number of clients to return per page.

Default: 20

Maximum: 100

Example: limit=5

page

For result lists that have multiple pages worth of results, used to determine which page of results you would like returned.

Default: 1

Example: page=8

Create

For associating an external SNI.PS publisher with the specified user.

Required Arguments

action

The action being performed. For this case the only possible value is create. The currently authenticated user is only able to make this call their own account.

Default: null

Example: action=create

auth

The authentication key returned from identifying with oauth.

url

The external location associated with the client. An endpoint that you would post a snip to.

Example: url=http%3A%2F%2Fwordpress%2Eexample%2Ecom%2Fwp%2Dadmin%2Fpost%2Dnew%2Ephp

name

The name associated with the external client.

Example: name=My%20Wordpress%20Blog

Optional Arguments

type

The type of client associated with the external location

Example: type=Wordpress

Remove

For removing the association with an external SNI.PS publisher from the specified user.

Required Arguments

action

The action being performed. For this case the only possible value is remove. The currently authenticated user is only able to make this call their own account.

Default: null

Example: action=remove

auth

The authentication key returned from identifying with oauth.

name

The name associated with the external client.

Example: name=My%20Wordpress%20Blog

Personal tools