Concepts of operation
The Admin web service allows for the following operations:
| Operation | Method Name | Required Permissions | Comments |
|---|---|---|---|
| Account & User Related Methods | |||
| Get Account balance | GetAccountPPCardsBalance2 | Primary user | |
| Open a new user | OpenUser | Primary user Only to manually pre-configured accounts (limit on number of users applies). |
All new usernames must conform to the Account’s ‘user namespace’ |
| Close user | CloseUser | Primary user | Automatically closes all services under that user. Makes user inaccessible. |
| Update user properties | SetUserProperties | Normal User | Any user may update own service properties |
| Get user properties | GetUserProperties | Normal User | |
| Fax Reception Related Methods | |||
| Get available inbound fax nodes (countries) required to open inbound service for a user. | GetInboundNodes | Primary user | |
| Add inbound service to an existing user | AddRxService | Primary user | Subject to charge (if applicable) |
| Drop inbound service from an existing user | RemoveRxService | Primary user | Will cease charge (if applicable) |
| Get inbound service properties | GetRxServiceProperties | Normal User | |
| Update user’s inbound properties | SetRxServiceProperties | Normal User | |
| Add an email forwarding address to an inbound user | AddRxEmailProperties | Normal User | |
| Set inbound forwarding properties | SetRxEmailProperties | Normal User | |
| Get inbound forwarding properties | GetRxEmailProperties | Normal User | |
| Fax Transmission Related Methods | |||
| Add outbound service to an existing user | AddTxService | Primary user | Subject to charge (if applicable) |
| Get outbound service properties | GetUserTxProperties | Normal User | |
| Drop outbound service from an existing user | RemoveTxService | Primary user | Will cease charge (if applicable) |
| Update user’s outbound properties | SetUserTxProperties | Normal User | Any user may update his own Tx properties |
| Utility Methods | |||
| Obtain all time zones | GetTimeZones | Anyone | A utility operation |
| Obtain all time zones in XML structure | GetTimeZonesXML | Anyone | A utility operation |
| Transaction & Cost Summary Methods | |||
| Get outbound activity list for all users (or for primary user only) | GetOutboundActivity | Primary User | A utility operation |
| Get inbound activity list for all users (or for primary user only) | GetInboundActivity | Primary User | A utility operation |