MackinVIA Adapter Actions
Define a connection to a MackinVIA Server.
Property | Value | Description |
|---|---|---|
url* | text, expression, variable | the Base URL of the MackinVIA REST service |
apiUsername* | text, expression, variable | API userName for authentication to the MackinVIA REST service |
apiKey* | password, string, expression, variable | Secret key for authentication to the MackinVIA REST service |
options | expression, variable | A record or JavaScript object with a field for each additional option. Currently defined fields are connectTimeout and socketTime which require a numeric value from 1 to 2147483647 (0x7FFFFFFF) that represents the number of milliseconds for the timeout, and 0 representing no timeout. |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
Global.MackinURL = "https://dss.mackinvia.com/"
Global.MackinApiUser = "MyMackinAdmin"
Global.MackinApiKey = <password>
conn = defineMackinVIAConnection(Global.MackinURL,
Global.MackinApiUser, Global.MackinApiKey)Delete a given MackinVIA User.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
accountID* | text, expression, variable | The accountID of the User |
userName* | text, expression, variable | The userName of the User |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
deleted = deleteMackinVIAUser(conn, Global.MackinAccountId, username)
Get a given MackinVIA User.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
accountID* | text, expression, variable | The accountID of the User |
userName* | text, expression, variable | The userName of the User |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
userRecord = getMackinVIAUser(conn, Global.MackinAccountId, username)
Get MackinVIA Users.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
accountID* | text, expression, variable | The accountID of the s |
lastNamePrefix | text, expression, variable | Lastname prefix of Users |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
userRecords = getMackinVIAUsers(conn, Global.MackinAccountId, "Jones")
Move a given MackinVIA User to a different Account.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
accountID* | text, expression, variable | The original accountID of the User |
userName* | text, expression, variable | The userName of the User |
newAccountID* | text, expression, variable | The new accountID of the User |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
moved = moveMackinVIAUser(conn, Global.MackinAccountId, username,
Global.OtherMackinAccountId)Rename a given MackinVIA User.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
accountID* | text, expression, variable | The accountID of the User |
userName* | text, expression, variable | The original userName of the User |
newUserName* | text, expression, variable | The new userName of the User |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
renamed = renameMackinVIAUser(conn, Global.MackinAccountId,
username, newUsername)Create or update a given MackinVIA User.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the MackinVIA connection definition |
record* | expression, variable | the User record |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
userTemplate = createRecord(false) setRecordFieldValue(userTemplate, "accountID", Global.MackinAccountId) setRecordFieldValue(userTemplate, "userName", username) setRecordFieldValue(userTemplate, "password",<Password>) created = saveMackinVIAUser(conn, userTemplate)
Supported MackinVIA User Record Fields
Field | Read-Only | Description |
|---|---|---|
accountID | Y | the account id of the school or organization the user is associated with |
userName | N | the user name of the User (required for create) |
password | N | the User password (required for create / write-only) |
lastName | N | the last name of the User |
firstName | N | the first name of the User |
middleName | N | the middle name of the User |
active | N | “True” if the User is active, “False” otherwise |
emailAddress | N | the email address of the User |