OnTime REST API
In This Topic
    OnTime REST API
    In This Topic

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

    Description

    This page contains the definitions for all of the endpoints that are available in the OnTime REST 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.

    Explore and experiment with the OnTime REST API and find additional documentation and examples through the built-in Swagger UI and OpenAPI tools.

    REST Endpoints
    Postapi/contact/post
    Creates a new Contact record, or updates an existing Contact record.
    Getapi/contacts
    Finds and returns unique identifiers for all Contacts that match a given criteria.
    Getapi/contacts/{id}
    Retrieves a single Contact object assigned to a given identifier.
    Getapi/contacts/authenticate
    Authenticates a Contact using a username and password, and returns its unique identifier on success.
    Postapi/customer/post
    Creates a new Customer record, or updates an existing Customer record.
    Getapi/customers
    Finds and returns unique identifiers for all Customers that match a given criteria.
    Getapi/customers/{id}
    Retrieves a single Customer object assigned to a given identifier.
    Getapi/customers/authenticate
    Authenticates a Customer using a username and password, and returns its unique identifier on success.
    Postapi/department/post
    Creates a new Department record, or updates an existing Department record.
    Getapi/departments
    Finds and returns unique identifiers for all Departments that match a given criteria.
    Getapi/departments/{id}
    Retrieves a single Department object assigned to a given identifier.
    Getapi/fileAttachments
    Retrieves a list of unique FileAttachment identifiers assigned to a single Order.
    Getapi/fileAttachments/{id}
    Retrieves a single FileAttachment object assigned to a given identifier.
    Postapi/invoice/post
    Creates a new Invoice record, or updates an existing Invoice record.
    Getapi/invoices
    Finds and returns unique identifiers for all Invoices that match a given criteria.
    Getapi/invoices/{id}
    Retrieves a single Invoice object assigned to a given identifier.
    Postapi/item/post
    Creates a new Item record, or updates an existing Item record.
    Getapi/items/{id}
    Retrieves a single Item object assigned to a given identifier.
    Postapi/location/post
    Creates a new Location record, or updates an existing Location record.
    Getapi/locations
    Finds and returns unique identifiers for all Locations that match a given criteria.
    Getapi/locations/{id}
    Retrieves a single Location object assigned to a given identifier.
    Postapi/order/codRequirement
    Updates the collect-on-delivery (COD) requirement for an existing Order.
    Deleteapi/order/fileAttachment/delete/{id}
    Permanently deletes an existing FileAttachment from an Order.
    Postapi/order/fileAttachment/post/{orderID}
    Attaches a FileAttachment to an existing Order.
    Postapi/order/getTotalCost
    Calculates and returns the total cost of a standalone Order.
    Postapi/order/post
    Creates a new Order record, or updates an existing Order record.
    Getapi/order/report
    Produces a report based upon a given Order.
    Getapi/order/signature
    Retrieves the collection or delivery signature from an existing Order.
    Postapi/order/signatureRequirement
    Updates the signature requirement for an existing Order.
    Getapi/order/updatePrices/{id}
    Updates the pricing of an existing Order.
    Postapi/order/updateStatus
    Updates the current status of an existing Order.
    Getapi/orders
    Finds and returns unique identifiers for all Orders that match a given criteria.
    Getapi/orders/{id}
    Retrieves a single Order object assigned to a given identifier.
    Getapi/orderStatusChanges/{orderID}
    Retrieves the entire Status history for a given Order.
    Postapi/payment/post
    Creates a new Payment record, or updates an existing Payment record.
    Getapi/payments
    Finds and returns unique identifiers for all Payments that match a given criteria.
    Getapi/payments/{id}
    Retrieves a single Payment object assigned to a given identifier.
    Getapi/priceModifiers/{id}
    Retrieves a single PriceModifier object assigned to a given identifier.
    Getapi/priceModifiersByName/{name}
    Retrieves a single PriceModifier object assigned to a given name.
    Getapi/priceSets/{id}
    Retrieves a single PriceSet object assigned to a given identifier.
    Getapi/priceSetsByName/{name}
    Retrieves a single PriceSet object assigned to a given name.
    Getapi/statuses
    Getapi/statuses/{id}
    Retrieves a single Status object assigned to a given identifier.
    Getapi/user/availability/{userID}
    Retrieves the current availability of a given User.
    Getapi/user/position
    Retrieves the UserPosition history for a given User within the specified date range.
    Getapi/user/position/{userID}
    Retrieves the most recent UserPosition object assigned to a given User .
    Postapi/user/updateAvailability
    Updates the availability of an existing User.
    Postapi/user/updatePosition
    Updates the position of a User relative to a given date and time.
    Postapi/userMiscCompensation/post
    Creates a new UserMiscCompensation record, or updates an existing UserMiscCompensation record.
    Getapi/userMiscCompensations/{id}
    Retrieves a single UserMiscCompensation object assigned to a given identifier.
    Getapi/users
    Finds and returns unique identifiers for all Users that match a given criteria.
    Getapi/users/{id}
    Retrieves a single User object assigned to a given identifier.
    Getapi/users/authenticate
    Authenticates a User using a username and password, and returns its unique identifier on success.
    Postapi/userSession/post
    Creates a new UserSession record, or updates an existing UserSession record.
    Getapi/userSessions
    Finds and returns unique identifiers for all UserSessions that match a given criteria.
    Getapi/userSessions/{id}
    Retrieves a single UserSession object assigned to a given identifier.
    Postapi/vehicle/post
    Creates a new Vehicle record, or updates an existing Vehicle record.
    Getapi/vehicles
    Finds and returns unique identifiers for all Vehicles that match a given criteria.
    Getapi/vehicles/{id}
    Retrieves a single Vehicle object assigned to a given identifier.
    Postapi/zone/post
    Creates a new Zone record, or updates an existing Zone record.
    Getapi/zones
    Finds and returns unique identifiers for all Zones that match a given criteria.
    Getapi/zones/{id}
    Retrieves a single Zone object assigned to a given identifier.
    Json Schemas
    ContactRepresents a comprehensive Contact record within the OnTime API.
    UserPositionRepresents a comprehensive UserPosition record within the OnTime API.
    CustomerRepresents a comprehensive Customer record within the OnTime API.
    DepartmentRepresents a comprehensive Department record within the OnTime API.
    InvoiceRepresents a comprehensive Invoice record within the OnTime API.
    ItemRepresents a comprehensive Item record within the OnTime API.
    LocationRepresents a comprehensive Location record within the OnTime API.
    ZoneRepresents a comprehensive Zone record within the OnTime API.
    OrderRepresents a comprehensive Order record within the OnTime API.
    TimeWindowRepresents a date range specification ( i.e. a time-window) for Order records within the OnTime API.
    StatusRepresents a comprehensive Status record within the OnTime API.
    UserDefinedFieldRepresents a comprehensive UserDefinedField record within the OnTime API.
    UserMiscCompensationRepresents a comprehensive UserMiscCompensation record within the OnTime API.
    VehicleTypeRepresents a comprehensive VehicleType record within the OnTime API.
    PriceModifierRepresents a comprehensive PriceModifier record within the OnTime API.
    FileAttachmentRepresents a comprehensive FileAttachment record within the OnTime API.
    PaymentRepresents a comprehensive Payment record within the OnTime API.
    PriceSetRepresents a comprehensive PriceSet record within the OnTime API.
    UserRepresents a comprehensive User record within the OnTime API.
    UserAvailabilityRepresents a comprehensive UserAvailability record within the OnTime API.
    UserSessionRepresents a comprehensive UserSession record within the OnTime API.
    VehicleRepresents a comprehensive Vehicle record within the OnTime API.

     

     

    © 2022 Vesigo Studios. All Rights Reserved.

    Send comments on this topic.