Using this API you can search users with details such as user name, employee id, email id and so on. You can enter any one of the following request parameters which is mandatory.
To authenticate the below API, see API Authentication and Authorization.
Service Name | HTTP Method |
|---|---|
| ADM_SearchAllUser | POST |
The SummitAI API URL is http://<<Customer_URL>>/REST/Summit_RESTWCF.svc/RESTServic e/ADM_SearchAllUser.
Replace <<Customer_URL>> with the customer’s API Server URL.
Sample Request
Sample Request
{
"_ProxyDetails": {
"ProxyID": 0,
"ReturnType": "JSON",
"OrgID":1
"APIKey":"xxxxxxxxxxxxxxxx",
"AuthType":"APIKEY"
},
"objFilters": {
"_emailID": "",
"_useID": 0,
"_userName": null,
"_customer": null,
"_location": null,
"_empID": 12345,
"_ntID": null
}
Request Parameters
| Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| emailID | STRING | An email ID of the user. | FALSE |
UseID | STRING | A user id of the user. | FALSE |
UserName | STRING | The name of the user. | FALSE |
Customer | STRING | Specify the customer name. A user can view the list of users mapped to the customer specified in the parameter. | FALSE |
Location | STRING | Specify the location. A user can view the list of users mapped to the location specified in the parameter. | FALSE |
| empID | STRING | Employee identification number of the User. | FALSE |
| ntID | STRING | NT login ID (Windows Login ID) of the User. | FALSE |
Sample Response
"{\"Errors\":\"\",\"Message\":null,\"OrgID\":0,\"Output\":\"{\\\"AllUserDetails\\\":{\\\ "UserDetails
\\\":[{\\\"UserID\\\":17,\\\"UserName\\\":\\\"Jyothi\\\",\\\"EmpID\\\":\\\"12345\
\\",\\\"Role\\\":\\\"Report\\\",\\\"RoleName\\\":\\\"Report\\\",\\\"EmailID\\\":\
\\"John@xyz.com\\\",\\\"NT_UID\\\":\\\"ss\\\\\\\\injputhra
SummitAI Suite | Web Services Document | Sierra 276
n\\\",\\\"Frm_UID\\\":\\\"John@xyz.com\\\",\\\"Frm_PWD\\
\":\\\"jxDPJ1jpS\\/mWgmOlLBzZWw==\\\",\\\"Org_Id\\\":1,\\\"Instance_Model\\\":
\\\"Dependent\\\",\\\"Org_Name\\\":\\\"Summit\\\",\\\"AccessCreate_Portfolio\\\": false,\\\"AccessEdit_Portfolio\\\":false,\\\"Customer\\\":9512,\\\"Customer_Name\\\":
\\\"Xyz\\\",\\\"Location\\\":2130,\\\"Location_Name\\\":\\\"Bangalore\\\",\\\" Userlevel\\\":null,\\\"User_Level\\\":\\\"\\\",\\\"Country\\\":null,\\\"Designation\\
\":\\\"Associate Engineer\\\",\\\"ContactNo\\\":null,\\\"MobileNo\\\":\\\"223344556677\\\",\\\"Join Date\\\":null,\\\"Access_ServerMon\\\":false,\\\"Access_IncidentMgmt\\\":true,\\\"Ac cess_CMCMDB\\\":true,\\\"Access_CMDB\\\":true,\\\"Access_RM\\\":true,\\\"Access
_KnowledgeMgmt\\\":true,\\\"Access_PortfolioMgmt\\\":true,\\\"Access_ServiceRequest
\\\":true,\\\"Access_ServiceCatalog\\\":true,\\\"Access_NetworkMon\\\":false,\\\"Acce ss_AssetMgmt\\\":true,\\\"Access_ProblemMgmt\\\":true,\\\"Access_ProjectMgmt\\\":t rue,\\\"Access_SkillPack\\\":true,\\\"Access_FinMgmt\\\":false,\\\"Access_SLA\\\":tru
e,\\\"SLAMgr\\\":false,\\\"AccessType_ServerMon\\\":\\\"No Access\\\",\\\"AccessType_IncidentMgmt\\\":\\\"No Access\\\",\\\"AccessType_CMCMDB\\\":\\\"No Access\\\",\\\"AccessType_CMDB\\\":\\\"\\\",\\\"AccessType_RM\\\":\\\"\\\",\\\ "AccessType_KnowledgeMgmt\\\":\\\"\\\",\\\"AccessType_PortfolioMgmt\\\":\\\"\\\ ",\\\"AccessType_ServiceRequest\\\":\\\"\\\",\\\"AccessType_ServiceCatalog\\\":\\\"\
\\",\\\"AccessType_NetworkMon\\\":\\\"No Access\\\",\\\"AccessType_AssetMgmt\\\":\\\"No Access\\\",\\\"AccessType_ProblemMgmt\\\":\\\"No Access\\\",\\\"AccessType_ProjectMgmt\\\":\\\"No Access\\\",\\\"AccessType_SkillPack\\\":\\\"\\\",\\\"AccessType_WorkOrder\\\":\\\ "No Access\\\",\\\"AccessType_FinMgmt\\\":\\\"No Access\\\",\\\"AccessType_SLA\\\":\\\"\\\",\\\"Address\\\":\\\"\\\",\\\"UserRema rks\\\":\\\"\\\",\\\"State\\\":\\\"\\\",\\\"City\\\":\\\"\\\",\\\"Pin\\\":\\\"\\\",
\\\"Active\\\":true,\\\"UT_ID\\\":35,\\\"AccessType_SkillPack1\\\":\\\"\\\",\\\"Acc ess_EProc\\\":true,\\\"AccessType_Eproc\\\":\\\"No Access\\\",\\\"Entity_Access\\\":\\\"\\\",\\\"TimeZone\\\":\\\"(UTC + 05:30) IST - India Standard
Time\\\",\\\"GMT_TimeDiff\\\":330,\\\"Access_EventMgmt\\\":false,\\\"AccessType_E ventMgmt\\\":\\\"No Access\\\",\\\"Keyword_Access\\\":\\\"\\\",\\\"ManagerName\\\":\\\"Jyothi\\\",\\
\"ProjMgmt_InstanceAccess\\\":\\\"\\\",\\\"Manager_UserID\\\":5,\\\"IM_ExtendedRo le\\\":\\\"RPT\\\",\\\"AM_ExtendedRole\\\":\\\"RPT\\\",\\\"CustomerMasterID\\\ ":5,\\\"OrgLogoActive\\\":null,\\\"CustomerLogoActive\\\":true,\\\"AM_EditTemplateI D\\\":0,\\\"DesignationID\\\":28685,\\\"PT_userAccessLevel\\\":\\\"Analyst\\\",\\\" PT_workgroupId\\\":3,\\\"PT_CostcentreID\\\":0,\\\"Alternative_EmailID\\\":\\\" , ,
,\\\",\\\"ManagerEmailID\\\":\\\"Antony@xyz.com\\\",\\\" ManagerEmployeeID\\\":\\\"4\\\"}]}}\",\"OutputObject\":null,\"TokenID\":null}"
Status and Error Codes
For more information, see Status and Error Messages