Web API – Users

Table of Contents

    List Users

    Request URL

    GET https://triplogmileage.com/web/api/users

    Query parameters

    None

    Find Single User

    Request URL

    GET https://triplogmileage.com/web/api/users/[user_id]

    Query parameters

    None

    Create User

    Request URL

    POST https://triplogmileage.com/web/api/users

    Query parameters

    None

    JSON request data

    {
    "firstName"    : String (required),
    "lastName"     : String (required),
    "email"        : String (required),
    "password"     : String (optional),
    "phone"        : String (optional),
    "dept"         : String (optional),
    "employeeId"   : String (optional), 
    "isAdmin"      : boolean (optional),
    "isMasterAdmin" : boolean (optional), 
    "isDriver"     : boolean (optional),
    "isAccountant" : boolean (optional),
    "locked"       : boolean (optional),
    "disabled"     : boolean (optional),
    "supervisorId" : Integer (optional), the user.id field you retrieved from a previous call
    "dailyMileageExemption" : int (optional),
    "exemptionOnlyWeekdays" : boolean (optional),
    "territory"    : String (optional), 2-letter state, comma separated
}

    Sample response

    {
    "message": "OK",
    "user": {
        "id": 6119,
        "url": "https://triplogmileage.com/web/api/users/6119",
        "email": "[email protected]",
        "display": "Driver, Sample",
        "firstName": "Sample",
        "lastName": "Driver",
        "phone": null,
        "dept": null,
        "supervisor": null,
        "admin": false,
        "masterAdmin": false, 
        "driver": true,
        "accountant": false,
        "locked": true,
        "disabled": false,
        "dailyMileageExemption": 10,
        "exemptionOnlyWeekdays": false,
        "lastSynced": null,
        "vehicles": "https://triplogmileage.com/web/api/users/6119/vehicles",
        "locations": "https://triplogmileage.com/web/api/users/6119/locations",
        "currentLocation": "https://triplogmileage.com/web/api/users/6119/currentLocation"
    }
}

    Update User

    Request URL

    PUT https://triplogmileage.com/web/api/users/[user_id]

    Query parameters

    None

    JSON request data

    Specify the fields you want to change. Leaving it out or setting to ‘null’ means no change to that field.

    {
    "firstName"    : String (optional),
    "lastName"     : String (optional),
    "phone"        : String (optional),
    "dept"         : String (optional), 
    "employeeId"   : String (optional),
    "isAdmin"      : boolean (optional),
    "isMasterAdmin" : boolean (optional), 
    "isDriver"     : boolean (optional),
    "isAccountant" : boolean (optional),
    "locked"       : boolean (optional),
    "disabled"     : boolean (optional),
    "supervisorId" : Integer (optional), the user.id field you retrieved from a previous call
    "dailyMileageExemption" : int (optional),
    "exemptionOnlyWeekdays" : boolean (optional), 
    "territory"    : String (optional), 2-letter state, comma separated
}

     

    Related Articles