list_agents

GET /list_agents

To get the TOTAL COUNT of the list of agents for search criteria.

Use this method FIRST to determine how many total records there are for the given criteria.

After you call this method, then call the method below, and pass the required paging parameters.

/list_agents?token=XXXXX&active_type=active

field	description
token	Credentials provided by Powersoft that allow access to the API
active_type	'active' = Only the active agents. 'inactive' = Only the inactive agents. 'all' = All the agents(active and inactive)

Returns

        {
            "api_response": {
                "response_code": "1",
                "response_msg": "OK",
                "response_id": ""
            },
            "total_count_list_agents": 2
        }
       

GET /list_agents

To get a list of agents.

/list_agents?token=XXXXX&active_type=active&page_number=1&page_size=10

field	description
token	Credentials provided by Powersoft that allow access to the API
active_type	'active' = Only the active agents. 'inactive' = Only the inactive agents. 'all' = All the agents(active and inactive)
page_number	The page number in the entire list. eg Page 1
page_size	The number of rows to return. eg 10 rows

Returns

        {
            "api_response": {
                "response_code": "1",
                "response_msg": "OK",
                "response_id": ""
            },
            "list_agents": [
                {
                    "agent_code_365": "AG1",
                    "agent_first_name": "AGENT",
                    "agent_last_name": "1",
                    "store_code_365": "100",
                    "active": true,
                    "tel_1": "",
                    "tel_2": "",
                    "mobile": "",
                    "fax": "",
                    "email": "",
                    "website": "",
                    "country_code_iso2": "",
                    "country_name": ""
                },
                {
                    "agent_code_365": "AG2",
                    "agent_first_name": "AGENT",
                    "agent_last_name": "2",
                    "store_code_365": "100",
                    "active": true,
                    "tel_1": "",
                    "tel_2": "",
                    "mobile": "",
                    "fax": "",
                    "email": "",
                    "website": "",
                    "country_code_iso2": "",
                    "country_name": ""
                }
            ]
        }
       

---