Versions Compared

Old Version 6

changes.mady.by.user Shilpa K

Saved on

compared with

New Version 7

changes.mady.by.user Mayuresh Balaji Kamble

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the code macro with the following parameter(s): [theme]
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

Scroll export button
scopecurrent
template-id4fda9400-a7df-4ede-a95f-e4ae5fcf4796
captionDownload this Page
add-onScroll PDF Exporter

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

Code Block
titleSample Request
linenumberstrue
{ 
"_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 NameTypeDescriptionMandatory
emailID

Status
colourGreen
titlestring

An email ID of the user.

Status
colourGrey
titleFALSE

UseID

Status
colourGreen
titlestring

A user id of the user.

Status
colourGrey
titleFALSE

UserName

Status
colourGreen
titlestring

The name of the user.

Status
colourGrey
titleFALSE

Customer

Status
colourGreen
titlestring

Specify the customer name. A user can view the list of users mapped to the customer specified in the parameter.

Status
colourGrey
titleFALSE

Location

Status
colourGreen
titlestring

Specify the location. A user can view the list of users mapped to the location specified in the parameter. 

Status
colourGrey
titleFALSE

empID

Status
colourGreen
titlestring

Employee identification number of the User.

Status
colourGrey
titleFALSE

ntID

Status
colourGreen
titlestring

NT login ID (Windows Login ID) of the User.

Status
colourGrey
titleFALSE


Code Block
titleSample Response
linenumberstrue
"{\"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

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


1

| |