Skip to content

inviteMIUserByQRCode ​

Allows an authenticated NI/MI user to use a QR Code to invite themselves to a Company (if not ready) along with 1-M Teams (if not already assigned).

Request ​

http
POST /rest/user/qrinvite

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

The following type of request should be posted as the body. NOTE: version should be 1 for now.

json
{
  "version": 1,
  "qrCodeUUID": "677449b5-83df-41ab-8400-9c3a4d391833"
}
json
{
  "version": 2,
  "qrCodeUUID": "9341e826-eead-4b23-b560-5d4302ec8b1d",
  "eConsents": [
    {
      "consentTypeCode": "C",
      "consentUUID": "f3c0b8b6-1708-4dd3-b301-8ec4fc156c24",
      "consentBooleanValue": true,
      "consentRequired": false
    },
    {
      "consentTypeCode": "C",
      "consentUUID": "800329d7-f334-48d8-8594-5bfb290dd69e",
      "consentBooleanValue": false,
      "consentRequired": false
    }
  ],
  "contactDetails": {
    "countryCode": "AU",
    "contactProfession": "Doctor",
    "contactSpecialty": "Gastroenterology",
    "contactCategory": "Whatever",
    "primaryMobile": "0405112233",
    "contactWorkAddresses": "123 Some Streetnullnull",
    "contactOtherWorkAddresses": "nullnullnull",
    "externalId": "ABC987-D875356",
    "title": "Lord",
    "firstname": "Hassam",
    "lastname": "Paul",
    "mobile": "041234567",
    "phone": "0411223344",
    "otherPhone": "02 9988776633",
    "department": "IT",
    "email1": "paul.hassam@yopmail.com",
    "company": "INTERACT Technology",
    "workAddress1": "123 Some Street",
    "city": "Sydney",
    "state": "AU-NSW",
    "postCode": "2031",
    "notes": "A lovely fella",
    "facebookId": "FacebookId123",
    "dateOfBirth": "31/07/1982",
    "faxNumber": "02 12345678",
    "condition": 1
  },
  "otherProfession": "Ventriloquist",
  "otherSpecialty": "Cat Herder"
}

Response ​

200 OK ​

JSON Reponse:

json
{
"errorCode": 0,
"errorMsg": "MI User invited."
}

Errors ​

ExceptionDescription
WSCompanyServiceUnavailableExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSQRCodeNotFoundExceptionSee Error Definitions
WSQRCodeInactiveOrDeletedExceptionSee Error Definitions
WSQRCodeNotActiveYetExceptionSee Error Definitions
WSQRCodeExpiredExceptionSee Error Definitions
WSCompanyServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvitationCancelledOrExpiredExceptionSee Error Definitions