OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/location/post (Post)
In This Topic
    Postapi/location/post
    In This Topic

    Resource Path: /sites/{company-id}/api/location/post

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

    Description
    Creates a new Location record, or updates an existing Location record.
    Request

    The request body is of type Location.

    A comprehensive Location object containing the new location information.

    Overview

    Location
    Represents a comprehensive Location record within the OnTime API.
    Zone : Zone
    The Zone record assigned to this Location.
    ID : string
    The unique identifier for this Zone record.
    Name : string
    The name of this Zone.
    PostalCodes : string
    The postal codes assigned to this Zone.
    ID : string
    The unique identifier for this Location record.
    ContactName : string
    The primary contact name associated with this Location.
    CompanyName : string
    The company name associated with this Location.
    AddressLine1 : string
    The street address of this Location.
    AddressLine2 : string
    Additional secondary information related to this Location's steet address.
    City : string
    The city or locality this Location resides within.
    State : string
    The state, province, or other civil entity this Location resides within.
    PostalCode : string
    The assigned postal code this Location resides within.
    Country : string
    The country or other national political entity this Location resides within.
    Comments : string
    Any additional comments associated with this Location.
    Email : string
    The email address assigned to this Location.
    Phone : string
    The phone number assigned to this Location.
    Category : string
    The category assigned to this Location.
    LatitudeLongitude : string
    The comma-delimited pair of geographic latitude/longitude coordinates that is assigned to this Location.
    201 Response

    The response body is of type object.

    Returns the created or updated Location object.
    Fault Responses
    FaultDescription
    Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
    Authorization key is invalid or no longer exists.
    Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.
    See Also