FS::ClientAPI::Signup - Front-end API for signing up customers
This module provides the ClientAPI functions for talking to a signup server. The signup server is open to the public, i.e. does not require a login. The back-end Freeside server creates customers, orders packages and services, and processes initial payments.
Given a PACKET from the signup server, looks up the agentnum to use for signing up a customer. This will use 'session_id' if the agent is authenticated, otherwise 'agentnum', otherwise the 'signup_server-default_agentnum' config. If the agent can't be found, returns an error packet.
Creates a new FS::prospect_main entry. PACKET must contain:
- either agentnum or session_id; if not, signup_server-default_agentnum will be used and must not be empty
- either refnum or referral_title; if not, signup_server-default_refnum will be used and must not be empty
- last and first (names), and optionally company and title
- address1, city, state, country, zip, and optionally address2
- emailaddress
and can also contain:
- one or more of phone_daytime, phone_night, phone_mobile, and phone_fax
- a 'comment' (will be attached to the contact)
State and country will be normalized to Freeside state/country codes if necessary.
Hey! The above document had some coding errors, which are explained below:
=over without closing =back