Change Updates

Do not miss any SITY API changes, ever again

Subscribe to the SITY API changelog to be up to date on recent changes.

RSS

Jan 21, 2024

main
1.1.0
Compare
1.1.0

API structure has changed

86 structure changes including:
21 Breaking changes
61 Additions
4 Modifications
21 Removals
Modified 4 Breaking
GET /client
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • companyID, clientID query parameters Added
GET /jobs
  • Response
  • 200 response Modified
    • application/json content type Modified
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • companyID query parameter Added
POST /client
  • Body
  • application/json content type Modified
    • Status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • clientID, isActive, createdBy, updatedBy properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • FirstName, LastName, Company, Phone, Email, isActive, CustomerSince, companyID, createdBy, updatedBy properties Added
  • 500 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /jobs
  • Body
  • application/json content type Modified
    • startDate, endDate, startTime, endTime, assignedTo properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • scheduleLater, Rrule, companyID, jobTypeID, createdBy, updatedBy properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • message property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • jobTitle, jobDescription, scheduleLater, Rrule, companyID, propertyID, jobStatusID, clientID, jobTypeID, createdBy, updatedBy properties Added
Removed 21 Breaking
DELETE /client/{clientID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /estimate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /jobs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /pricebook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /property
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /timeEntry
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /client/{clientID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /estimate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /timeEntry
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /property
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /pricebook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /jobs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /estimate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /client/{clientID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /timeEntry
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /property
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /pricebook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /estimate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /timeEntry
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /property
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /pricebook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 61
POST /taxRates
POST /timeEntries
POST /users
POST /visits
PUT /client
PUT /company
PUT /customOptions/{id}
PUT /jobAssignment/{jobID}
PUT /jobTypes/{jobTypeID}
PUT /jobs/{jobID}
PUT /pricebookItems/{pricebookItemID}
PUT /pricebooks/{pricebookID}
PUT /properties/{propertyID}
PUT /roles/{roleId}
PUT /taxRates/{taxRateID}
PUT /timeEntries/{timeEntryID}
PUT /users/{userID}
PUT /visits/{visitID}
POST /roles
GET /jobs/{jobID}
GET /jobTypes/{jobTypeID}
GET /jobTypes
GET /jobLineItems
GET /jobAssignment
GET /customOptions/{id}
GET /customOptions
GET /company
DELETE /visits/{visitID}
DELETE /users/{userID}
DELETE /timeEntries/{timeEntryID}
DELETE /taxRates/{taxRateID}
DELETE /roles/{roleId}
DELETE /properties/{propertyID}
DELETE /pricebooks/{pricebookID}
DELETE /pricebookItems/{pricebookItemID}
DELETE /jobs/{jobID}
DELETE /jobTypes/{jobTypeID}
DELETE /jobAssignment/{jobID}
DELETE /customOptions/{id}
DELETE /client
POST /properties
POST /pricebooks
POST /pricebookItems
POST /jobTypes
POST /jobLineItems
POST /jobAssignment
POST /customOptions
POST /company
GET /visits/{visitID}
GET /visits
GET /users
GET /timeEntries/{timeEntryID}
GET /timeEntries
GET /taxRates
GET /roles/{roleId}
GET /roles
GET /properties/clientAndProperty
GET /properties
GET /pricebooks/{pricebookID}
GET /pricebooks
GET /pricebookItems