The Users API allows users to Create, Update and Get information about User records in Fusion

Overview

he Users API will be created in Karmak Unity to allow 3rd Parties to Create, Update and Get information about users setup in the Fusion Business System.

POST

https://api.karmak.io/api/unity/{version}/unityapi/user/CreateUser

PUT

https://api.karmak.io/api/unity/{version}/unityapi/user/UpdateUser

GET

https://api.karmak.io/api/unity/{version}/unityapi/user/{username}

Specifications

GET

• The GET method will be used to retrieve information about a specific User Record in Fusion.

• The user will need to pass in the Username of the User record in Fusion they wish to return.

  • Provide the Fusion Username (without the brackets) where indicated above in the GET Request with the {username} to get information about the specific user.

• The Response of the GET will include all the fields that are able to be passed in on the POST of the User API.

POST

• The POST method will be used to create User Records in Fusion.

• Only one User record will be allowed in a single request call.

• The User Identity section will be ignored when creating a User

• If the user chooses to create a User Branch Department record for the User record the Branch, Department and User Group must all be passed in and match valid values in Fusion.

• Multiple User Branch Departments will be allowed to be created for a User.

• If the User Branch Department record isn’t created, the User record created will not be allowed to login to Fusion.

• If the User Name already exists in Fusion the record won’t be created.

• A response will be provided with a message section that will outline a success or any issues that prevented the User from being created.

• The Fusion Username used in the Unity API call will be used as the Add and Last Update User of the User created.

• The Date and Time the Unity API call was made will be used as the Add Date and Last Update of the User created.

• The User record will be created in Fusion following the standard create logic of the PMB90500 User and PMB90550 User Branch Department form in Fusion outside of any specific rules listed in this section and the POST/PUT Request Fields Section below.

• The following fields will be set by default upon creating a User record

  • Language will be set to English

  • Search Record will be set to 50

  • Email Delivery will be set to SMTP

PUT

• The PUT method will be used to update User Records in Fusion.

• Only one User record will be allowed in a single request call.

• Only fields that are expected to be updated should be passed in outside of the required fields.

• In order to update an existing User record the user will be required to send in the User in the User Identity section to find a match. If a match isn’t found an update will not be performed.

• In order to update an existing User Branch Department record on the User record the user will be required to send in the Branch and Department in the User Identify section that matches an existing User Branch Department record on the User record.

• Only 1 Branch Department Record will be allowed to be sent in the BranchDepartmentList Node.

• In order to Add or Remove a Branch Department Record on an existing User Record, don’t pass in the Branch and Department as part of the Identity, rather pass those values in on the BranchDepartmentList Node section and use the Action field to set whether you are looking to Add or Remove the Branch Department Record.

• A response will be provided with a message section that will outline a success or any issues that prevented the User from being updated.

• The Fusion Username used in the Unity API call will be used as the Last Update User of the User updated.

• The Date and Time the Unity API call was made will be used as the Last Update Date of the User updated.

Request Fields

GET Request and Response

api/unity/v1/unityapi/User/TechUser1

{
    "UserName": "TechUser1",
    "Password": null,
    "FirstName": "Tech1",
    "LastName": "User1",
    "IsInactive": false,
    "IsDisabled": false,
    "Email": "",
    "DomainUserName": null,
    "SearchRecordsReturned": 50,
    "EmailSettingType": "SMTP",
    "AddDate": "2020-07-28T00:36:40.167",
    "AddUser": "karmak",
    "UpdateUser": "karmak",
    "EmployeeNumber": null,
    "Language": "English",
    "LastUpdate": "2020-07-28T00:36:40.167",
    "BranchDepartmentList": [
        {
            "Branch": "01",
            "Department": "Service",
            "UserGroup": "System Administrator",
            "IsDepartmentAdministrativeUser": true,
            "IsBranchAdministrativeUser": true,
            "IsDivisionAdministrativeUser": true,
            "IsCorporateAdministrativeUser": true,
            "IsEnterpriseAdministrativeUser": true,
            "IsDefaultRecord": true,
            "Action": null
        }
    ],
    "WorkPhone": "",
    "HomePhone": "",
    "CellPhone": "",
    "Fax": "",
    "Pager": ""
}

POST Request - Multiple Branch Department Records

{
    "UserName": "spool_Unity4",
    "Password": "unity",
    "FirstName": "Stephanie",
    "LastName": "Pool",
    "BranchDepartmentList": [
        {
            "Branch": "01",
            "Department": "service",
            "UserGroup": "System Administrator",
            "IsDepartmentAdministrativeUser": true,
            "IsBranchAdministrativeUser": false,
            "IsDivisionAdministrativeUser": true,
            "IsCorporateAdministrativeUser": true,
            "IsEnterpriseAdministrativeUser": true,
            "IsDefaultRecord": false
        },
        {
            "Branch": "01",
            "Department": "Parts",
            "UserGroup": "System Administrator",
            "IsDepartmentAdministrativeUser": false,
            "IsBranchAdministrativeUser": true,
            "IsDivisionAdministrativeUser": true,
            "IsCorporateAdministrativeUser": true,
            "IsEnterpriseAdministrativeUser": true,
            "IsDefaultRecord": false
        }
    ]
}

POST Response

{
    "Status": "Succesfully created user.",
    "Message": null
}

PUT Request - Update Branch Department Record

{
    "Identity": {
        "Branch": "01",
        "Department": "service",
        "UserName": "dpool_Unity"
    },
    "BranchDepartmentList": [
        {
            "IsEnterpriseAdministrativeUser": true,
            "IsDivisionAdministrativeUser":false,
	       	"IsCorporateAdministrativeUser":false
        }
    ]
}

PUT Response

{
    "Status": "User updated.",
    "Message": null
}

PUT Request - Add Branch Department Record

{
    "Identity": {
        "UserName": "TechUser13"
    },

        "BranchDepartmentList": 
    [
        {
            "Branch": "01",
            "Department":"Service",
            "UserGroup":"System Administrator",
            "IsBranchAdministrativeUser":true,
            "IsEnterpriseAdministrativeUser":true,
            "Action":"Add"
        }
    ]
}

PUT Response

{
    "Status": "User updated.",
    "Message": null
}

PUT Request - Remove Branch Department Record

{
    "Identity": {
        "UserName": "ffbob38"
    },

        "BranchDepartmentList": 
    [
        {
              "Branch": "Cambridge",
              "Department":"Parts",
              "Action":"Remove"
        }
    ]
}

PUT Response

{
    "Status": "User updated.",
    "Message": null
}