OnTime SOAP API
In This Topic
    OnTime SOAP API
    In This Topic

    Uri: https://secure.ontime360.com/sites/{company-id}/ws/soap_v1.svc

    Description
    This page contains the definitions for all of the methods that are available in the OnTime SOAP API. These endpoints are added to the base Customer Web Portal URI for the account to be accessed. If you do not know the Customer Web Portal URI for the account you are working with, please contact the account administrator to obtain this URI.
    SOAP Methods
    Method/sites/{company-id}/ws/soap_v1.svc/AuthenticateContact
    Authenticates a Contact using a username and password, and returns its unique identifier on success.
    Method/sites/{company-id}/ws/soap_v1.svc/AuthenticateCustomer
    Authenticates a Customer using a username and password, and returns its unique identifier on success.
    Method/sites/{company-id}/ws/soap_v1.svc/AuthenticateUser
    Authenticates a User using a username and password, and returns its unique identifier on success.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateContact
    Creates a new Contact record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateContactProxy
    Creates an empty Contact record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateCustomer
    Creates a new Customer record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateCustomerProxy
    Creates an empty Customer record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateDepartment
    Creates a new Department record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateDepartmentProxy
    Creates an empty Department record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateFileAttachmentProxy
    Creates an empty FileAttachment record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateInvoice
    Creates a new Invoice record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateInvoiceProxy
    Creates an empty Invoice record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateItem
    Creates a new Item record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateItemProxy
    Creates an empty Item record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateLocation
    Creates a new Location record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateLocationProxy
    Creates an empty Location record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateOrder
    Creates a new Order record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateOrderFileAttachment
    Attaches a FileAttachment to an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateOrderProxy
    Creates an empty Order record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreatePayment
    Creates a new Payment record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreatePaymentProxy
    Creates an empty Payment record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateUserMiscCompensation
    Creates a new UserMiscCompensation record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateUserMiscCompensationProxy
    Creates an empty UserMiscCompensation record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateUserSession
    Creates a new UserSession record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateUserSessionProxy
    Creates an empty UserSession record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateVehicle
    Creates a new Vehicle record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateVehicleProxy
    Creates an empty Vehicle record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateZone
    Creates a new Zone record.
    Method/sites/{company-id}/ws/soap_v1.svc/CreateZoneProxy
    Creates an empty Zone record.
    Method/sites/{company-id}/ws/soap_v1.svc/DeleteOrderFileAttachment
    Permanently deletes an existing FilaAttachment from an Order.
    Method/sites/{company-id}/ws/soap_v1.svc/GetContact
    Retrieves a single Contact object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetContactList
    Finds and returns unique identifiers for all Contacts that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetContactListWhere
    Finds and returns unique identifiers for all Contacts that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetCurrentUserPosition
    Retrieves the most recent UserPosition object assigned to a given User.
    Method/sites/{company-id}/ws/soap_v1.svc/GetCustomer
    Retrieves a single Customer object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetCustomerList
    Finds and returns unique identifiers for all Customers that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetCustomerListWhere
    Finds and returns unique identifiers for all Customers that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetDepartment
    Retrieves a single Department object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetDepartmentList
    Finds and returns unique identifiers for all Departments that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetDepartmentListWhere
    Finds and returns unique identifiers for all Departments that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetInvoice
    Retrieves a single Invoice object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetInvoiceList
    Finds and returns unique identifiers for all Invoices that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetInvoiceListWhere
    Finds and returns unique identifiers for all Invoices that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetItem
    Retrieves a single Item object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetLocation
    Retrieves a single Location object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetLocationList
    Finds and returns unique identifiers for all Locations that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetLocationListWhere
    Finds and returns unique identifiers for all Locations that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrder
    Retrieves a single Department object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderFileAttachment
    Retrieves a single FileAttachment object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderFileAttachmentList
    Retrieves a list of unique FileAttachment identifiers assigned to a single Order.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderList
    Finds and returns unique identifiers for all Orders that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderListWhere
    Finds and returns unique identifiers for all Orders that match a given criteria.v
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderReport
    Produces a report based upon a given Order.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderSignature
    Retrieves the collection or delivery signature from an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderStatusChanges
    Retrieves the entire Status history for a given Order.
    Method/sites/{company-id}/ws/soap_v1.svc/GetOrderTotalCost
    Calculates and returns the total cost of a standalone Order object.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPayment
    Retrieves a single Payment object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPaymentList
    Finds and returns unique identifiers for all Payments that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPaymentListWhere
    Finds and returns unique identifiers for all Payments that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPriceModifier
    Retrieves a single PriceModifier object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPriceModifierByName
    Retrieves a single PriceModifier object assigned to a given name.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPriceSet
    Retrieves a single PriceSet object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetPriceSetByName
    Retrieves a single PriceSet object assigned to a given name.
    Method/sites/{company-id}/ws/soap_v1.svc/GetStatus
    Retrieves a single Status object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetStatusList
    Finds and returns unique identifiers for pre-defined Statuses that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUser
    Retrieves a single User object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserAvailability
    Retrieves the current availability of a given User.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserList
    Finds and returns unique identifiers for all Users that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserListWhere
    Finds and returns unique identifiers for all Users that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserMiscCompensation
    Retrieves a single UserMiscCompensation object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserPosition
    Retrieves the UserPosition history for a given User within the specified date range.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserSession
    Retrieves a single UserSession object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserSessionList
    Finds and returns unique identifiers for all UserSessions that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetUserSessionListWhere
    Finds and returns unique identifiers for all UserSessions that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetVehicle
    Retrieves a single Vehicle object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetVehicleList
    Finds and returns unique identifiers for all Vehicles that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetVehicleListWhere
    Finds and returns unique identifiers for all Vehicles that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetZone
    Retrieves a single Zone object assigned to a given identifier.
    Method/sites/{company-id}/ws/soap_v1.svc/GetZoneList
    Finds and returns unique identifiers for all Zones that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/GetZoneListWhere
    Finds and returns unique identifiers for all Zones that match a given criteria.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateContact
    Updates an existing Contact record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateCustomer
    Updates an existing Customer record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateDepartment
    Updates an existing Customer record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateInvoice
    Updates an existing Invoice record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateItem
    Updates an existing Item record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateLocation
    Updates an existing Location record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateOrder
    Updates an existing Order record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateOrderCODRequirement
    Updates the collect-on-delivery (COD) requirement for an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateOrderPrices
    Updates the pricing of an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateOrderSignatureRequirement
    Updates the signature requirement for an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateOrderStatus
    Updates the current status of an existing Order.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdatePayment
    Updates an existing Payment record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateUserAvailability
    Updates the availability of an existing User.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateUserMiscCompensation
    Updates an existing UserMiscCompensation record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateUserPosition
    Updates the position of a User relative to a given date and time.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateUserSession
    Updates an existing UserSession record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateVehicle
    Updates an existing Vehicle record.
    Method/sites/{company-id}/ws/soap_v1.svc/UpdateZone
    Updates an existing Zone record.

     

     

    © 2022 Vesigo Studios. All Rights Reserved.

    Send comments on this topic.