Next Topic

Previous Topic

Book Contents

Session Timer

Reference Types

WorkTypes:

0 - AdminTask

1 - WorkOrder (Service Billing)

2 - Tickets (Service Desk)

Required fields by SessionTimer type

AdminTask Required fields

TimerData Object: 
  clock : int 
  startTime : DateTime string formatted as yyyy-mm-ddTHH:mm:ss 
  state : 1 
  color : (Hex code) 
  workTypes (SessionTimerWorkTypes object) 
    color : same as TimerData.color 
    hint : string 
    startAtSave : “on” or “” 
    work-types : 0 
    taskName : the adminTask.Id (string representation of a decimal) 
    taskReference : string 
    taskNote : string 
  xtype : "ktimer" 
  startAtSave : "on" or "" 
  hint : string (same as workTypes.hint) 

WorkOrder Required Fields

TimerData Object 
  clock : int 
  startTime : DateTime string formatted as yyyy-mm-ddTHH:mm:ss 
  state : 1 
  color : (Hex code) 
  workTypes (SessionTimerWorkTypes object) 
    color : same as TimerData.color 
    hint : string 
    startAtSave : “on” or “” 
    work-types : 1 
    customer : customerId (decimal as string) 
    workOrder : workOrderId (decimal as string) 
    workOrderLineItem : workOrderItemId (decimal as string) 
    workOrderNote : string 
    workOrderHiddenNote : "on" or "" 
    workOrderBillable : "on" or "" 
    basicServiceBillingWorkOrdersFlag : "Y" or "N" 
    resourceTypeId : (decimal as string) 
    workOrderActivityType : (decimal as string) 
    workOrderDefaultRate : (currency) 
    overrideRateBoolean : "on" of "" 
    overrideRate : (currency) 
  xtype : "ktimer" 
  startAtSave : "on" or "" 
  hint : string (same as workTypes.hint) 

ServiceDesk Required Fields

TimerData Object 
  clock : int 
  startTime : DateTime string formatted as yyyy-mm-ddTHH:mm:ss 
  state : 1 
  color : (Hex code) 
  workTypes (SessionTimerWorkTypes object) 
    color : same as TimerData.color 
    hint : string 
    work-types : 2 
    serviceDesk : serviceDeskId (decimal as string) 
    serviceDeskStatus : not sure yet.. 
    ticket-filter : 1 
    incident : ticketId (decimal as string) 
    serviceDeskNote : string 
    serviceDeskHiddenNote : "on" or "" 
    showNoteOnInvoiceFlag : "on" or "" 
    serviceDeskBillable : "on" or "" 
    tasksFlag : "N" 
    customerId : (decimal as string) 
  xtype : "ktimer" 
  startAtSave : "on" or "" 
  hint : string (same as workTypes.hint)

SessionTimer Object Model

{ 
  "id": 0, 
  "ref": "string", 
  "effId": 0, 
  "transId": 0, 
  "hasUserData": "Y", 
  "status": 0, 
  "partitionId": 0, 
  "timerData": { 
    "clock": 0, 
    "startTime": "string", 
    "state": 0, 
    "color": "string", 
    "workTypes": { 
      "color": "string", 
      "hint": "string", 
      "startAtSave": "string", 
      "work-types": 0, 
      "taskName": "My task", 
      "taskReference": "My Task", 
      "taskNote": "Task Note", 
      "customer": "string", 
      "workOrder": "string", 
      "workOrderLineItem": "string", 
      "workOrderNote": "string", 
      "workOrderHiddenNote": "string", 
      "workOrderBillable": "string", 
      "detailedServiceBillingWorkOrdersFlag": "string", 
      "basicServiceBillingWorkOrdersFlag": "string", 
      "workOrderResourceTypeServicebillingLabelHidden": "string", 
      "activityTypeServiceBillingLabelHidden": "string", 
      "serviceDesk": "string", 
      "serviceDeskStatus": "string", 
      "serviceDeskBillable": "string", 
      "ticket-filter": 0, 
      "incident": "string", 
      "serviceDeskCustomerName": "string", 
      "serviceDeskWorkOrderLabel": "string", 
      "activityTypeLabelHidden": "string", 
      "workOrderResourceTypeLabelHidden": "string", 
      "serviceDeskNote": "string", 
      "serviceDeskHiddenNote": "string", 
      "showNoteOnInvoiceFlag": "string", 
      "serviceDeskActivityType": "string", 
      "tasksFlag": "string", 
      "workOrdersFlag": "string", 
      "detailedWorkOrdersFlag": "string", 
      "basicWorkOrdersFlag": "string", 
      "customerId": "string", 
      "task-filter": 0, 
      "resourceTypeId": "string", 
      "workOrderActivityType": "string", 
      "workOrderDefaultRate": "string", 
      "overrideRateBoolean": "string", 
      "overrideRate": "string" 
    }, 
    "xtype": "string", 
    "startatsave": "string", 
    "hint": "string" 
  } 
} 


In This Chapter

Get Admin Task

Get Admin Task by ID

Get All Customers

Get All Work Orders

Get Work Order Items

Get All Work Order Types

Get All Activity Types

Get All Service Desks

Get Service Desk Status Types

Get All Service Desk Tickets

Get All Session Timers

Get Session Timer Object

Create Admin Tasks

Create Sessions Timer

Delete Session Timer

Update Session Timer

Remove Session Timer