Basic Information

Detailed Information

Report Data

The ServiceCall Datatype

The following datatype will be JSONified and returned for methods which retrieve ServiceCall values. Method requests which create new ServiceCalls or update existing ServiceCalls will be parsed for a JSON representation of this data structure.

When creating a new ServiceCall or modifying an existing ServiceCall, please set the AccountId to 0, or your AccountId as returned by the /Account method. Any other value will result in an Authentication error.

public class ServiceCall
{
publicUInt64AccountId; // The AccountId associated with this ServiceCall
publicUInt64ServiceCallId; // A unique identifier for the Service Call. Use this when making further API calls specific to this Service Call.
publicStringWorkOrder; // An optional parameter that can be set for your Service Calls.
publicStringDescription; // An optional parameter that can be set for your Service Calls.
publicDateTime?DispatchDate; // An optional parameter that can be set for your Service Calls.
publicDateTime?RequestDate; // An optional parameter that can be set for your Service Calls.
publicDateTime?EstimatedStartDate; // An optional parameter that can be set for your Service Calls.
publicStringCustomerName; // An optional parameter that can be set for your Service Calls.
publicStringCaller; // An optional parameter that can be set for your Service Calls.
publicStringEquipmentId; // An optional parameter that can be set for your Service Calls.
publicStringItem; // An optional parameter that can be set for your Service Calls.
publicStringTerritoryDesc; // An optional parameter that can be set for your Service Calls.
publicStringTechnician; // An optional parameter that can be set for your Service Calls.
publicStringBillCode; // An optional parameter that can be set for your Service Calls.
publicStringCallType; // An optional parameter that can be set for your Service Calls.
publicStringPriority; // An optional parameter that can be set for your Service Calls.
publicStringStatus; // An optional parameter that can be set for your Service Calls.
publicStringComment; // An optional parameter that can be set for your Service Calls.
publicStringStreet; // An optional parameter that can be set for your Service Calls.
publicStringCity; // An optional parameter that can be set for your Service Calls.
publicStringState; // An optional parameter that can be set for your Service Calls.
publicStringZipCode; // An optional parameter that can be set for your Service Calls.
publicStringEquipmentRemarks; // An optional parameter that can be set for your Service Calls.
publicStringContact; // An optional parameter that can be set for your Service Calls.
publicStringContactPhone; // An optional parameter that can be set for your Service Calls.
publicDouble?Latitude; // If Latitude and Longitude are left null, the API will attempt to retrieve their values from the Street, City, State, and ZipCoded values provided.
publicDouble?Longitude; // If Latitude and Longitude are left null, the API will attempt to retrieve their values from the Street, City, State, and ZipCoded values provided.
publicStringFlagColor; // The color of the label this service call will display in the webapp, in 6-character RGB format (eg, "FF0000" for bright red)
publicStringTextColor; // The color of the label text this service call will display in the webapp, in 6-character RGB format (eg, "0000FF" for bright green)
publicStringMarkerName; // The content of the label text this service call will display in the webapp
}

The ServiceCall Methods

The following list provides a reference for all valid /ServiceCall HTTP requests.

  • DELETE v1/ServiceCall/{id}?account={account}

    Summary: Removes a specific Service Call from your Account.

    Returns: True if the deletion succeeded, false if the deletion failed.

    Parameters:

    • id: The Id of the Service Call to remove. (FromUri)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • GET v1/ServiceCall/{id}?account={account}

    Summary: Retrieves a specific Service Call from your account.

    Returns: The requested Service Call

    Parameters:

    • id: The Id of the Service Call to retrieve (FromUri)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • GET v1/ServiceCall?status={status}&account={account}

    Summary: Gets many or all of the Service Calls listed for your Account.

    Returns: The list of Service Calls with the provided status, if specified, or all Service Calls for your Account.

    Parameters:

    • status: (Optional) If provided, limits the results to Service Calls with the provided status (FromUri)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • POST v1/ServiceCall?account={account}

    Summary: Creates a new Service Call for your Account.

    Returns: The newly-created Service Call as it exists in the database.

    Parameters:

    • ToCreate: The Service Call to create. (FromBody)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • PUT v1/ServiceCall?account={account}

    Summary: Updates an existing Service Call in your Account.

    Returns: The Service Call as it exists in the database, post-update.

    Parameters:

    • ToUpdate: The Service Call to update, with changes applied. (FromBody)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)