apidocs/resource_UserREST.html

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>Ranger REST API: UserREST</title>  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">  <link rel="stylesheet" href="css/enunciate.css">   </head> <body data-spy="scroll" data-target="#apinav"> <nav class="navbar navbar-inverse navbar-fixed-top"> <div class="container-fluid"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="index.html">Ranger REST API: UserREST</a> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="resources.html">Resources</a></li> <li><a href="data.html">Data Types</a></li> </ul> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li><a href="#resource_UserREST_searchUsers_GET"><abbr title="GET /users"><span class="sideoverflow">GET /users</span></abbr></a></li> <li><a href="#resource_UserREST_create_POST"><abbr title="POST /users"><span class="sideoverflow">POST /users</span></abbr></a></li> <li><a href="#resource_UserREST_update_PUT"><abbr title="PUT /users"><span class="sideoverflow">PUT /users</span></abbr></a></li> <li><a href="#resource_UserREST_createDefaultAccountUser_POST"><abbr title="POST /users/default"><span class="sideoverflow">POST /users/default</span></abbr></a></li> <li><a href="#resource_UserREST_suggestUserFirstName_GET"><abbr title="GET /users/firstnames"><span class="sideoverflow">GET /users/firstnames</span></abbr></a></li> <li><a href="#resource_UserREST_getUserProfile_GET"><abbr title="GET /users/profile"><span class="sideoverflow">GET /users/profile</span></abbr></a></li> <li><a href="#resource_UserREST_getUserProfileForUser_GET"><abbr title="GET /users/{userId}"><span class="sideoverflow">GET /users/{userId}</span></abbr></a></li> <li><a href="#resource_UserREST_deactivateUser_POST"><abbr title="POST /users/{userId}/deactivate"><span class="sideoverflow">POST /users/{userId}/deactivate</span></abbr></a></li> <li><a href="#resource_UserREST_changeEmailAddress_POST"><abbr title="POST /users/{userId}/emailchange"><span class="sideoverflow">POST /users/{userId}/emailchange</span></abbr></a></li> <li><a href="#resource_UserREST_changePassword_POST"><abbr title="POST /users/{userId}/passwordchange"><span class="sideoverflow">POST /users/{userId}/passwordchange</span></abbr></a></li> <li><a href="#resource_UserREST_setUserRoles_PUT"><abbr title="PUT /users/{userId}/roles"><span class="sideoverflow">PUT /users/{userId}/roles</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> <ol class="breadcrumb" id="top"> <li class="active dropdown"><a href="index.html">Home</a></li> <li class="active dropdown"><a href="resources.html">Resources</a></li> <li class="dropdown"><a href="resource_UserREST.html">UserREST</a></li> </ol> <h1 class="page-header">UserREST <small>Resource</small></h1> <p></p> <div id="resource_UserREST_searchUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for UserProfile</p> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUserList.html">VXPortalUserList</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUserList.html">VXPortalUserList</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /users Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "vXPortalUsers" : [ { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_create_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_update_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_createDefaultAccountUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/default <a href="../users/default" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /users/default Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_suggestUserFirstName_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/firstnames <a href="../users/firstnames" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">letters</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /users/firstnames Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_getUserProfile_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/profile <a href="../users/profile" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>This method returns the VUserProfile for the current session</p> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /users/profile Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_getUserProfileForUser_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/{userId} <a href="../users/{userId}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Return the VUserProfile for the given userId</p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">userId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /users/{userId} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_deactivateUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/deactivate <a href="../users/{userId}/deactivate" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Deactivate the user</p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">userId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /users/{userId}/deactivate Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_changeEmailAddress_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/emailchange <a href="../users/{userId}/emailchange" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">userId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPasswordChange.html">VXPasswordChange</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPasswordChange.html">VXPasswordChange</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /users/{userId}/emailchange Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "loginId" : "...", "emailAddress" : "...", "resetCode" : "...", "oldPassword" : "...", "updPassword" : "...", "myClassType" : 12345 } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "loginId" : "...", "password" : "...", "status" : 12345, "emailAddress" : "...", "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "userSource" : 12345, "notes" : "...", "userRoleList" : [ "...", "..." ], "myClassType" : 12345, "groupIdList" : [ 12345, 12345 ], "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermissions" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "otherAttributes" : "...", "configProperties" : { "property1" : "...", "property2" : "..." }, "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_changePassword_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/passwordchange <a href="../users/{userId}/passwordchange" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">userId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXPasswordChange.html">VXPasswordChange</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPasswordChange.html">VXPasswordChange</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXResponse.html">VXResponse</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXResponse.html">VXResponse</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /users/{userId}/passwordchange Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "loginId" : "...", "emailAddress" : "...", "resetCode" : "...", "oldPassword" : "...", "updPassword" : "...", "myClassType" : 12345 } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "statusCode" : 12345, "msgDesc" : "...", "messageList" : [ { "name" : "...", "rbKey" : "...", "message" : "...", "objectId" : 12345, "fieldName" : "...", "myClassType" : 12345 }, { "name" : "...", "rbKey" : "...", "message" : "...", "objectId" : 12345, "fieldName" : "...", "myClassType" : 12345 } ], "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_UserREST_setUserRoles_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/users/{userId}/roles <a href="../users/{userId}/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">userId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXStringList.html">VXStringList</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXStringList.html">VXStringList</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_VXResponse.html">VXResponse</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXResponse.html">VXResponse</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /users/{userId}/roles Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "statusCode" : 12345, "msgDesc" : "...", "messageList" : [ { "name" : "...", "rbKey" : "...", "message" : "...", "objectId" : 12345, "fieldName" : "...", "myClassType" : 12345 }, { "name" : "...", "rbKey" : "...", "message" : "...", "objectId" : 12345, "fieldName" : "...", "myClassType" : 12345 } ], "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> </div> </footer> </div> </div> </div>  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> <script> $(function() { $(".clickable-row").click(function() { window.document.location = $(this).data("href"); }); $('[data-toggle="tooltip"]').tooltip() }); </script> </body> </html>

apidocs/resource_UserREST.html (1,892 lines of code) (raw):