Interfax Admin Web service v1.0 - Documentation

Note: These are OPTIONAL, advanced methods which allow management of user accounts. They are NOT necessary for regular faxing of documents.

Introduction

The Admin Web service enables customers to handle many aspects of account and users' management programmatically.

Overview - basic terms

In the Interfax service, there are three main entities, with parent-child relationships:

Account
User (Child of Account; no limit on number)
Service (Child of User; up to one each of: inbound fax or outbound fax)

Account

An Account is the administrative and paying entity. It holds billing and payment information, as well as the balance available for sending faxes. Each Account can have one or more Users.

Accounts can be configured by Interfax staff to enable programmatic opening of new users. By default, Accounts are not configured to enable this.

Accounts may be added manually by Interfax staff, or by registering online for service. They cannot be added through these administration methods.

View all Account-related Web Service methods.

User

A User is an operational entity. It is identified by a username and a password. Under each User, services may be defined which are available for the user, and service properties may be set. Each user can have a sending service (alternatively referred to as "TX") or a reception service (alternatively referred to as "RX"). The User properties are specified in Appendix B - structures.

One important property of the User is whether it is a 'Primary user' (as opposed to a 'Normal user'). A Primary user has certain privileges in the scope of the Account and its users, e.g. can view other users' activity and can manage billing details.

A User's namespace is a prefix assigned to an account, which restrict new users' usernames to start with it followed by a dot. For example: If a User's namespace is 'somecompany', then all new usernames must take on the form of 'somecompany.someuser'. A username like 'otheruser' (note no preceding namespace) is not valid for such an account.

View all User Admin Web Service methods.

Services

Rx Service and Tx Service hold properties relevant to receiving and sending faxes, respectively. Please refer to Appendix B - Structures for an extensive description of these properties.

Additional Methods

Additionally, there are methods available to set and get properties which are not within the Account-User-Services structure. They are:

Concepts of operation

The Admin Web Service WSDL may be accessed at http://ws.interfax.net/admin.asmx?WSDL.

Note that you need to contact InterFAX Support to enable access to administrative Web Service methods in your account.