diff options
author | Ivan Kohler <ivan@freeside.biz> | 2017-09-13 14:18:48 -0700 |
---|---|---|
committer | Ivan Kohler <ivan@freeside.biz> | 2017-09-13 14:18:48 -0700 |
commit | ff911c91cdc360cdd8282b15e4191a79b96efee8 (patch) | |
tree | 2a50208d804f835c4039fa0aacf446b43469b16d /FS/FS/API.pm | |
parent | 8ca189326db97dfb6265a51e46bc988002dbe625 (diff) |
better documentation for UIA's API needs, RT#76831
Diffstat (limited to 'FS/FS/API.pm')
-rw-r--r-- | FS/FS/API.pm | 54 |
1 files changed, 53 insertions, 1 deletions
diff --git a/FS/FS/API.pm b/FS/FS/API.pm index f9cc37e..6e09713 100644 --- a/FS/FS/API.pm +++ b/FS/FS/API.pm @@ -16,7 +16,20 @@ FS::API - Freeside backend API =head1 SYNOPSIS - use FS::API; + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_info', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); =head1 DESCRIPTION @@ -525,6 +538,23 @@ sub update_customer { Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret +Example: + + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_info', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); + =cut sub customer_info { @@ -542,6 +572,28 @@ sub customer_info { Returns customer service information. Takes a list of keys and values as parameters with the following keys: custnum, secret +Example: + + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_list_svcs', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); + + foreach my $cust_svc ( @{ $result->{'cust_svc'} } ) { + #print $cust_svc->{mac_addr}."\n" if exists $cust_svc->{mac_addr}; + print $cust_svc->{circuit_id}."\n" if exists $cust_svc->{circuit_id}; + } + =cut sub customer_list_svcs { |