Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Clients are the entries in AffinityLive where you note the companies whom you provide services to. These can range from partners and vendors to your actual customers, and can even include you! These Client entries also act as the central repository for all information related to that group, including correspondence, project and sales updates, and contact information for their employees.

Endpoints

ResourceDescription
GET jobsReturns a list of jobs.
GET jobs/countReturns the number of jobs found in AffinityLive.
GET jobs/recentReturns the most recently created jobs.
GET jobs/newestReturns the most recently modified jobs.
GET jobs/:job_idReturns a job identified by its id.
PUT jobs/:job_idUpdates a job identified by its id.
DELETE jobs/:job_idDeletes a job identified by its id.
POST jobsCreate a new job object.

Filters

Job filters can be used to filter through lists of jobs. You can defined filters in the _filter parameter.

modified_beforeUnix Timestamp. e.g 1341281246- Filter out jobs that were not modified before this date.
modified_afterUnix Timestamp. e.g 1341281246- Filter out jobs that were not modified after this date.
created_beforeUnix Timestamp. e.g 1341281246- Filter out jobs that were not created before this date.
created_afterUnix Timestamp. e.g 1341281246- Filter out jobs that were not created after this date.
manager_idArray of number. e.g 13,10,15- Filter out jobs that do not have a manager with supplied manager id.
standingArray of standing status strings. For example standing(pending,active)- filter out jobs that do not have the supplied standing.

The following sample will return jobs created before Tue, 03 Jul 2012 02:07:26 GMT< that have a manager with an id 10, 11 or 100 and are currently "pending". 

Code Block
languagebash
/jobs?_filter=created_before(1341281246),manager_id(10,11,100),standing(pending)