Home → API Documentation → Registration Process → api/Registration
5.3. api/Registration
This API call is used to supply all registration values to register a new user.
Registration Steps
• Step 1 - Capture the user’s email address and use api/EmailCheck call to check if the email address is already registered. If the email is registered, prompt the user that they already have an account and to log in. Otherwise, continue to step 2.
• Step 2 - Capture the user's Company/Organisation Postcode and use the api/PortalList call to return matching records. The user should then be able to choose an existing record to add themselves to or be given a "My Organisation Is Not Listed" option.
• Step 3 - Allow the user to make a selection. If the user selects an existing record, maintain the selected "cid" value for use in the main api/Registration call later. If the user selects "My Organisation Is Not Listed", maintain an empty string as the "cid" to be used in api/Registration call later.
• Step 4 - If the user selects an existing record (cid not empty), maintain all details about the Company/Organisation as the user is not required to enter this information again. Only values relating to the individual are required. Note: Users registering against an existing record should not be offered the ability to activate a subscription.
• Step 5 - If the user selects "My Organisation Is Not Listed", make a call to api/PortalList to return any available subscription packages. Maintain the user’s selection.
• Step 6 - Show the user any applicable terms & conditions and maintain the content.
• Step 7 – Submit the “Parameters To Submit” as detailed below in the api/Registration call.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values. If parameters below are highlighted with “¬”, they cannot be submitted as blank values if the CompanyIndividual field is submitted as C.
If parameters are highlighted with “#”, they cannot be submitted as blank values if the CompanyIndividual field is submitted as I.
| Parameter | Parameter Help | Parameter Data Type |
| cid | Maintained from earlier selection (joining existing company) or an empty string (new company/individual). | String – Max 50 chars |
| ssid | Maintained from earlier selection (ssid available from api/PortalList) or an empty string. | String – Max 50 chars |
| CompanyIndividual* | Either "C", if the user is registering a "Company" or "I" if they are registering as an "Individual". | String – Max 1 char |
| Company¬ | Company’s name. | String – Max 250 chars |
| CompanyTel¬ | Company’s telephone. | String – Max 30 chars |
| CompanyEmail | Company’s email address. | String – Max 250 chars |
| CompanyWeb | Company’s website URL. Should prefix with “http://” or “https://”. | String – Max 250 chars |
| Category* | The value passed to the API must be ListValue (Text Value not ID). If “CompanyIndividual” is “I” then submit “None”. | String – Provide ListValue from api/PortalList “BusinessCategory”. |
| Employees | Number of employees at the company. If an empty string will default to 1. | Integer |
| CompanyAddress1¬ | First line of company’s address. | String – Max 75 chars |
| CompanyAddress2 | Second line of company’s address. | String – Max 75 chars |
| CompanyAddress3 | Third line of company’s address. | String – Max 75 chars |
| CompanyAddress4¬ | Fourth line of company’s address. | String – Max 75 chars |
| CompanyCounty¬ | The value passed to the API must be ListValue (Text Value not ID). Submit a default value of “None” if no selection is made. | String – Provide ListValue from api/PortalList “County”. |
| CompanyPostcode¬ | Postcode of company’s address. | String – Max 15 chars |
| CompanyCountry¬ | The value passed to the API must be ListValue (Text Value not ID). Submit a default value of “None” if no selection is made. | String – Provide ListValue from api/PortalList “Country”. |
| ContactFirstName* | Contact’s first name. | String – Max 100 chars |
| ContactLastName* | Contact’s last name. | String – Max 100 chars |
| ContactEmail* | Contact’s email address as entered when checked through api/EmailCheck. | String – Max 200 chars |
| Password* | Contact’s password. Must convert String to Base64 encrypted format. | String – Max 150 chars |
| ContactTel* | Contact’s telephone number. | String – Max 30 chars |
| ContactMob | Contact’s mobile number. | String – Max 25 chars |
| ContactWhereHear* | The value passed to the API must be ListValue (Text Value not ID). Submit a default value of “None” if no selection is made. | String – Provide ListValue from api/PortalList “WhereHear”. |
| ContactAddress1# | First line of contact’s address. | String – Max 75 chars |
| ContactAddress2 | Second line of contact’s address. | String – Max 75 chars |
| ContactAddress3 | Third line of contact’s address. | String – Max 75 chars |
| ContactAddress4# | Fourth line of contact’s address. | String – Max 75 chars |
| ContactCounty* | The value passed to the API must be ListValue (Text Value not ID). Submit default value of “None” if no selection made. | String – Provide ListValue from api/PortalList “County”. |
| ContactPostcode# | Postcode of contact’s address. | String – Max 15 chars |
| ContactCountry* | The value passed to the API must be ListValue (Text Value not ID). Submit default value of “None” if no selection made. | String – Provide ListValue from api/PortalList “Country”. |
| Consent* | String value maintained from earlier display. Provide consent text as this will be noted within the CRM when consent was given and what the consent was. | String |
This API call does NOT require the API Key to be supplied as part of the call.
Return Response
The API call ResponseMessage will return a range of fields. The following fields of data will be relevant for your purposes.
| Field | Field Help |
| uid | Contact’s new uid that has just been created. |
| EmailAddress | Contact’s email address. |
| FirstName | Contact’s first name. |