JSON API » peers » peers/list

Gets the fields of peers.

Input parameters

Requires authentication and the user role privilege if destination=1, else commerce role privilege if routing=1, else the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
customer	Integer	ID of customer.	No	Customer of authentication user.
destination	Integer	1 to only return peers customer can route to, 0 for all.	No	0
routing	Integer	1 to only return peers resellers can create routes to, 0 for all.	No	0

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the peers table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/peers/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.