User Audit Object

The User Audit object is a generic object that contains audit information from the different areas of the application. Some of the object's properties have different meanings depending on what application module generated the audit. The details of which are described below. 

Related pages:

User Audit Object Formats

JSON Format
 {      
    "Attrs" : {
       "ReasonCode" : ""
    },
    "Category": "1002",
    "RefCode": "9000"
    "Subcategory": "12001",
    "TimeStamp": "2014-02-26T03:12:16.368Z"
}

User Audit Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
AttrscollectionThis collection contains additional audit information which varies based on the type of audit generated.
Categorystring

Identifies the source module of the audit record.

Valid values are:

  • 1001 - Inventory audit
  • 1002 - Work order audit
  • 1003 - GPS breadcrumb
  • 1004 - Ping
  • 1005 - Activity
  • 1006 - UserStatus
  • 1007 - Manual Login
LatitudestringIf GPS is enabled and available, this property identifies the latitude coordinate where the technician was when this audit record was created.
LongitudestringIf GPS is enabled and available, this property identifies the longitude coordinate where the technician was when this audit record was created.
RefCodestring

If set, this property contains a reference to an object related to the audit record. The meaning of RefCode changes based on the value of the Category and Subcategory properties.

The table below identifies the meaning of the RefCode value based on the Category and Subcategory values.

Category ValueRefCode Meaning
1001

For subcategory 11001 (Receive Inventory) RefCode contains the ID of the Receive Inventory request object associated with the audit record.

For subcategory 11002 (Physical Inventory Count) RefCode contains the ID of the physical inventory count object associated with the audit record.

For subcategory 11003 (Transfer Inventory) RefCode contains the ID of the Transfer object associated with the audit record.

1002Contains the Work Order Number associated with the audit record.
1003n/a
1004n/a
1005Contains the Activity object ID associated with the audit record.


Subcategorystring

Further identifies the type audit event that occurred.

Valid values for each type of Category are:

Category ValueSubcategory Values
1001
  • 11001 - Receive Inventory
  • 11002 - Physical Inventory Count
  • 11003 - Transfer Inventory
1002
  • 12001 - Enroute. The technician has started traveling to the Customer location
  • 12002 - Travel Complete. Travel has been completed.
  • 12003 - Onsite. Technician is onsite at the Customer location
  • 12004 - Onsite Complete. Technician has completed the onsite visit at the Customer
  • 12005 - Delivered. The work order has been received by the mobile device.
  • 12006 - Read. The technician has opened the work order and viewed its summary details.
  • 12007 - Accepted.
  • 12008 - Rejected.
  • 12009 - Rescheduled.
1003n/a
1004

n/a

1005
  • 12003 - Started. Technician has started the Activity
  • 12004 - Complete. Technician has completed Activity
  • 12005 - Delivered. The Activity has been received by the mobile device.
  • 12006 - Read. The technician has opened the Activity and viewed its summary details.
1006
  • 16001 - Checked-In. The technician has completed the checkin process.
  • 16002 - On Break. The technician has started a break.
  • 16003 - End Break. The technician has ended a break.
  • 16004 - Checked-Out. The technician has completed the checkout process.


TimeStampdatetimeIdentifies the date and time, in UTC format, when the audit event occurred.