TimeEntry

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The TimeEntry endpoint provides the API consumer with access to methods pertaining to time entries and related data objects. The endpoint allows consumers to load time entry data, add new time entries, and update time entries.

Methods

URL base/Workforce/TimeEntry/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the TimeEntry endpoint.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object
[
    {
        "HttpAction": "Get",
        "MethodName": "GetTimeEntriesByTicket",
        "Description": "Returns time entries given the passed in ID value of the ticket (see Path).",
        "Path": "/TimeEntry/GetTimeEntriesByTicket/25032"
    }
]
URL base/Workforce/TimeEntry/GetTimeEntriesByTicket/ID
Action GET
Description Returns a collection of TimeEntry objects when given an ID of a valid ticket in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a ticket in the M4 database.
Returns A JSON collection of TimeEntry data objects
Sample Return Object
[
     {
          "ID": 1,
          "TimeCodeId": 1,
          "TimeCode": "GATH_EQP",
          "ApptId": 31,
          "TicketID": 1,
          "TechID": 15,
          "Minutes": 4,
          "Capital": 1,
          "Time": "2013-07-31T00:06:42.493",
          "PayCodeId": null,
          "CustomerServiceID": null,
          "Comment": null,
          "CustomerID": 258598
     },
     {
          "ID": 5,
          "TimeCodeId": 4,
          "TimeCode": "DOC",
          "ApptId": 191,
          "TicketID": 1,
          "TechID": 18,
          "Minutes": 15,
          "Capital": 1,
          "Time": "2013-11-05T15:11:31.44",
          "PayCodeId": 1,
          "CustomerServiceID": null,
          "Comment": null,
          "CustomerID": 258598
     }
]

Was this article helpful?

Related Articles