selfRegisterMIUser

Self-registers a user for MI. To be called by our apps ONLY. i.e. not within HTML assets. Version 2 (9-JAN-17) - Added support to optionally sign-up to a Wall or Event by passing a QR Access Code (which must be setup as part of QR Code). Also added support to optionally pass more Contact details such as Title, Profession, Specialty, Notes etc etc. Version 5 (MAY 2023) - support multiple qrAccessCodes also fixed bug with duplicate identifiers.

Request

POST /rest/user/mi/selfregister

Headers

See Aaron for apiKey

Parameters

A MISelfRegistrationJSON object. Password must be between 8 and 30 chars and contain 1 char, 1 number etc. Supported versions 1 through 5.

• Version 1: All V1 fields are required.
• Version 2: Only V1 fields required.
• Version 3: Country required.
• Version 4: Country & Profession (User Type in UIs) required. Depending on Profession (User Type) puts user into different default MI team. Added field condition which should be saved to both User and Contact levels.
• Version 5: Supports multiple QRAccessCodes via qrAccessCodes array.

Parameter	Type	Required	Description
qrAccessCode		No	Short access code of a QR code relating to either a wall or event
sendWelcomeEmail	boolean	No	Tells SAM to not send the normal Welcome Email relating to in-app self-registration
contactDetails	object	No	Contains all Contact details to be saved into a SAM Contact record. Using existing ContactJSON object. NOTE: field length validations are performed on String values. All ContactJSON fields optional.

IMPORTANT: for externalId please do not send empty string '' as there is a unique index on companyId and externalId WHERE CONTACT_EXTERNALID IS NOT NULL (it does take into account empty string).

VERSION 1 EXAMPLE

{
  "version": 1,
  "password": "mypassword",
  "apiKey": "708a5f7f-5016-4a89-a0d5-df6ba77ffdd2",
  "emailAddress": "aaron@interact.technology",
  "firstName": "Aaron Web Service Test",
  "lastName": "McMullen"
}

{
  "uInteractTsAndCs": "Y",
  "uSAMTrackingConsent": "Y",
  "uiCloudConsent": "Y",
  "uGoogleConsent": "Y",
  "uFacebookConsent": "Y",
  "storeContactIdentifiers": false,
  "version": 5,
  "apiKey": "SOMEAPIKEY",
  "emailAddress": "test@yopmail.com",
  "firstName": "My Test",
  "lastName": "User",
  "password": "Pa55word",
  "qrAccessCode": "ACCESSCODE",
  "qrAccessCodes" : ["Access1", "Access2"],
  "contactDetails": {
    "countryCode": "AU",
    "otherCountryCode": "NZ",
    "contactProfession": "Doctor",
    "contactSpecialty": "Gastroenterology",
    "contactCategory": "My CRM Category",
    "primaryMobile": "0405112233",
    "externalId": "ABC987-D875356",
    "title": "Lord",
    "firstname": "My Test",
    "lastname": "User",
    "mobile": "041234567",
    "phone": "0411223344",
    "otherPhone": "02 9988776633",
    "department": "IT",
    "email1": "test@yopmail.com",
    "company": "INTERACT Technology",
    "city": "Sydney",
    "state": "AU-NSW",
    "postCode": "2031",
    "ownedBy": "Someone",
    "notes": "A lovely fella",
    "facebookId": "catherder31",
    "dateOfBirth": "31/07/1982",
    "otherAddress1": "Other address 1",
    "otherAddress2": "Other address 2",
    "otherAddress3": "Other address 3",
    "otherCity": "Auckland",
    "otherState": "AU-QLD",
    "otherPostcode": "2000",
    "faxNumber": "02 12345678",
    "wallConsent1": "My wall consent 1",
    "wallConsent2": "My wall consent 2",
    "wallConsent3": "My wall consent 3",
    "wallConsent4": "My wall consent 4",
    "wallConsent5": "My wall consent 5",
    "wallConsent6": "My wall consent 6",
    "eventConsent1": "My event consent 1",
    "eventConsent2": "My event consent 2",
    "eventConsent3": "My event consent 3",
    "eventConsent4": "My event consent 4",
    "additional1": "Additional 1",
    "additional2": "Additional 2",
    "additional3": "Additional 3",
    "lead": "My lead",
    "representativeName": "Rep Name"
  },
  "title": 1,
  "countryCode": "AU",
  "profession": 1,
  "specialty": 9,
  “condition”: 2,
  "otherTitle": "Sir",
  "otherProfession": "Ventriloquist",
  "otherSpecialty": "Cat Herder",
  "validationFields": [
    {
      "id": 1,
      "value": "ABC0123456789"
    }
  ],
  "sendWelcomeEmail": true,
  "dietaryRequirements": "Halal"
}

Response

200 OK

JSON Reponse:

{
"errorCode": 0,
"errorMsg": "MI User self-registered."
}

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSEmailAlreadyExistsException	See Error Definitions
WSAccountLockedException	See Error Definitions
WSInvalidEmailDomainNameException	See Error Definitions
WSPasswordLengthException	See Error Definitions
WSPasswordServiceException	See Error Definitions
WSUserServiceException	See Error Definitions
WSUserServiceUnavailableException	See Error Definitions