Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

ON THIS PAGE

These endpoints allow users to manage their settings in the current network.

/self/

GET

Gets the information associated with the user in the current network.

Response Body

  • id: 

  • login: The user's login name

  • password: The user password. This may return "null".

  • firstName: The user's first name

  • lastName: The user's last name

  • creationDate:

  • lastModifiedDate: 

  • activationDate:

POST

Registers the user in the current network.

Parameters

  • [returnURL]

Request Body

  • Person

Response Body

  • Person

PUT

Updates the users information in the current network.

Request Body

  • Person

/self/profile

GET

Gets the users profile settings.

Response Body

  • Dictionary<string, string>

POST

Updates the users profile settings.

Request Body

  • KeyValuePair<string, string>

Response Body

  • KeyValuePair<string, string>

/self/profile/{key}

GET

Gets the users profile settings.

Response Body

  • String

PUT

Updates the users profile settings.

Request Body

  • String

Response Body

  • [KeyValuePair<string, string>]

DELETE

Deletes the users profile settings.

/self/networks/

GET

Retrieve networks associated with the user.

Response Body

  • Network[]

POST

Create a network that will be associated with the user.

Parameters

  • key

Request Body

  • Network

Response Body

  • Network

/self/networks/{networkId}/

/self/networks/{networkName}/

GET

Retrieve the network name.

Request Body

  • Network

/self/networks/{networkId}/settings/

GET

Retrieve the network settings.

Response Body

  • Network Settings

/self/networks/{networkName}/settings/

PUT

Request Body

  • Network Settings

/self/networks/{networkId}/subscription/

/self/networks/{networkName}/subscription/

GET

Gets the network subscription information for the user.

Response Body

  • Network Subscription

/self/users/

GET

Gets the names of the user(s) on the current network

Response Body

  • User[]

/self/users/{userId}/

GET

Gets the id(s) of the users on the current network

Response Body

  • User

/self/users/{userId}/role

GET

Gets the role(s) of the users on the current network

Response Body

  • Role

/self/users/{userId}/role/permissions

GET

Gets the role permissions of the users on the current network

Response Body

  • Permission[]
  • Dictionary<string, string>

/self/users/{userId}/profile/

POST

Request Body

  • [KeyValuePair<string, string>]

Response Body

  • [KeyValuePair<string, string>]

/self/users/{userId}/profile/{key}

GET

Retrieve the user profile.

Response Body

  • String

PUT

Update the user profile.

Request Body

  • String

Response Body

  • [KeyValuePair<string, string>]

DELETE

Delete the user profile.

/self/users/{userId}/notifications/

GET

Get user notification settings.

Response Body

  • UserNotificationSettings

PUT

Update user notification settings.

Request Body

  • UserNotificationSettings


/self/users/{userId}/permissions/

GET

Get user permissions.

Response Body

  • Permission[]



  • No labels