API Documentation


This API allows to search list of users with search parameter. The new API added is “ADM_SearchUser”.

Service Name 

HTTP Method 

ADM_SearchUser

Post 


Sample Request

Below are the sample request to search User list.

 

Request payload:

{

    "ServiceName": "ADM_SearchUsers",

    "objCommonParameters": {

        "_ProxyDetails": {

            "APIKey": "P9DYAvNptCmTgmVLTllwuIUfAJGk83TiSftXIYR/fkQ=",

            "AuthType": "APIKEY",

            "ProxyID": 0,

            "ReturnType": "JSON",

            "orgid": 1

        },

        "UserSearchFilters": {

            "SearchText": "S100",

            "IncludeInActive": 0,

            "DomainName": "XXXXX",

            "Location": "",

            "Customer": "XXXXX",

            "PageSize": 10,

            "PageIndex":0

        }

    }


Request Parameters

Parameter Name

Type

Description

Mandatory

Search Text

String

Enter the search text

True

IncludeInActive

String

A Checkbox to include Inactive users if any.

False

Domain Name

String

Select the domain name of the user list.

True

Location

String

Location of the user list

True

Customer

String

Select the customer’s name of the user list

True


Sample Response

{

    "Errors": "",

    "Message": null,

    "Output": "",

    "TokenID": "DAC5E0E875DF1399F26A1A1E8BA0B1EF54BC0782377B9826AF452DF9DFFC6EFA7ECC07CB441DF629FA02EE0D4E937ADC8CAAA7E9275BBF8AFBFF511A1159540628E15CD7C5E51C49D9FEAD0CDF34906A3A066E8C0B35D2CC8C30F29D501560F4856C7492D142D06CFCBFBD05CF9D9EEE195772E6D4741238EB43B0BB3AF2A5543BB5353E313BC231BAE3FDBD5FAE3ACBD40FC510280084BE7C4D7819E2C2F4BBB194F47F83D116345EE3B8D693ADC8CA",

    "OrgID": 0,

    "OutputObject": {

        "AllUserDetails": {

            "UserDetails ": [

                {

                    "ROWNUM": "1",

                    "TotalRows": 4,

                    "UserID": 1799,

                    "UserName": "john",

                    "EmpID": "S100",

                    "Role": "RPT",

                    "RoleName": null,

                    "EmailID": "john1@xyz.com",

                    "NT_UID": null,

                    "Frm_UID": "john3@abc.com",

                    "Frm_PWD": "ofKG8cRo9a91NIp1tzohaziaR4UhN6NXzOTmXUd9Or8=",

                    "Org_Id": 1,

                    "Instance_Model": "Dependent",

                    "Org_Name": "harman",

                    "AccessCreate_Portfolio": false,

                    "AccessEdit_Portfolio": false,

                    "Customer": 872,

                    "Customer_Name": "SUMMIT",

                    "Location": 18474,

                    "Location_Name": "chennai2",

                    "Userlevel": 17514,

                    "User_Level": "level5",

                    "Country": "India",

                    "Designation": "Lead",

                    "ContactNo": "+81-0944022338789",

                    "MobileNo": "9123456780",

                    "JoinDate": "2020-05-02 00:00:00",

                    "Address": "Gollastreet,Mumbai",

                    "UserRemarks": "This is created by me",

                    "State": "Maharastra",

                    "City": "Vijayawada",

                    "Pin": "534235",

                    "Active": true,

                    "UT_ID": 35,

                    "ManagerName": "john",

                    "Manager_UserID": 3,

                    "IM_ExtendedRole": "RPT",

                    "AM_ExtendedRole": "RPT",

                    "CustomerMasterID": 1,

                    "OrgLogoActive": null,

                    "CustomerLogoActive": false,

                    "AM_EditTemplateID": 0,

                    "DesignationID": 17513,

                    "Alternative_EmailID": null

                },

                {

                    "ROWNUM": "2",

                    "TotalRows": 4,

                    "UserID": 1800,

                    "UserName": "john",

                    "EmpID": "S100",

                    "Role": "RPT",

                    "RoleName": null,

                    "EmailID": "john1@wxyz.com",

                    "NT_UID": null,

                    "Frm_UID": "johna6@wxyz.com",

                    "Frm_PWD": "ofKG8cRo9a91NIp1tzohaziaR4UhN6NXzOTmXUd9Or8=",

                    "Org_Id": 1,

                    "Instance_Model": "Dependent",

                    "Org_Name": "harman",

                    "AccessCreate_Portfolio": false,

                    "AccessEdit_Portfolio": false,

                    "Customer": 872,

                    "Customer_Name": "SUMMIT",

                    "Location": 18474,

                    "Location_Name": "chennai2",

                    "Userlevel": 17514,

                    "User_Level": "level5",

                    "Country": "India",

                    "Designation": "Lead",

                    "ContactNo": "+81-0944022338789",

                    "MobileNo": "9123456780",

                    "JoinDate": "2022-10-11 00:00:00",

                    "Address": "Gollastreet,Mumbai",

                    "UserRemarks": "This is created by me",

                    "State": "Maharastra",

                    "City": "Vijayawada",

                    "Pin": "534235",

                    "Active": true,

                    "UT_ID": 35,

                    "ManagerName": "john",

                    "Manager_UserID": 3,

                    "IM_ExtendedRole": "RPT",

                    "AM_ExtendedRole": "RPT",

                    "CustomerMasterID": 1,

                    "OrgLogoActive": null,

                    "CustomerLogoActive": false,

                    "AM_EditTemplateID": 0,

                    "DesignationID": 17513,

                    "Alternative_EmailID": null

                }

            ]

        }

    },

    "OutputID": 0,

    "Input": null

}