Did you find this summary helpful?
Thank you for your feedback
GET /Sites
Returns a list of sites.
Query Parameters
| Parameter | Type | Description |
|---|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
GET /Sites/{id}
Get site properties for a site by ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
POST /Sites
Create a new site.
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | The name of the site. |
| description | String | The site description. |
| sitetype | String | The type of site. |
PUT /Sites/{id}
Update site properties.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | The name of the site. |
| description | String | The site description. |
GET /Sites/{id}/groups/{childId}
Get a group from a specified site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
| childId* | Guid | The group id. |
Query Parameters
| Parameter | Type | Description |
|---|
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
GET /Sites/{id}/groups
Get a list of groups belonging to a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
Query Parameters
| Parameter | Type | Description |
|---|
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
| q | String | A VisualVault REST API Data Query. |
POST /Sites/{id}/groups
Create new groups for a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | Name of the group. |
| description | String | A description of the group. |
PUT /Sites/{id}/groups/{childId}
Update a group for a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
| childId* | Guid | The group id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | The group name. |
| description | String | The group description. |
GET /Sites/{id}/users/{childId}
Get properties of a site user.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
| childId* | Guid | The user id. |
Response Codes
| Code | Description |
|---|
| 404 | Not Found |
GET /Sites/{id}/users
Get a list of users for a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
Query Parameters
| Parameter | Type | Description |
|---|
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction.- asc: Ascending order
- desc: Descending order
|
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|
| 404 | Not Found |
POST /Sites/{id}/users
Create new users for a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
Body Parameters
| Parameter | Type | Description |
|---|
| userId* | String | User ID of the user. |
| firstname* | String | First name of the user. |
| middleinitial | String | Middle initial of the user. |
| lastname* | String | Last name of the user. |
| emailaddress* | String | Email address of the user. |
| password* | String | User password. |
| passwordneverexpires | Bool | Does the password expire? |
| passwordexpires | datetime | Date when the user password will expire. |
| mustchangepassword | Bool | Forces a password change upon first login. |
| sendemail | Bool | Send an email to the user once the account is created. |
PUT /Sites/{id}/users/{childId}
Update user properties belonging to a site.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The site id. |
| childId* | Guid | The user id. |
Body Parameters
| Parameter | Type | Description |
|---|
| firstname | String | User first name. |
| middleinitial | String | User middle initial. |
| lastname | String | User last name. |
| emailaddress | String | Email address. |
| employmentstatus | String | The user's employment status. |
| employeeid | String | The user's employee ID. |
| passwordneverexpires | Bool | Does the user password expire? |
| useridneverexpires | Bool | Does the user ID expire? |
| passwordexpires | datetime | Date of expiration for the user password. |
| passwordanswer | String | The password security answer. |
| passwordquestion | String | The password security question. |
| useridexpires | datetime | The expiration date for the user ID. |
PUT /Sites/ChangeUserSite
Change the current site for a user.
Body Parameters
| Parameter | Type | Description |
|---|
| userid | Guid | The user ID. |
| newsiteid | Guid | The site ID. |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
