set_status

(CATS API 2.0)

Sets a candidate's status in a job order pipeline.


[ List of API Functions ] [ Frequently Asked Questions ]

Base URL
https://[subdomain].catsone.com/api/set_status?transaction_code=[code]
[subdomain]: This is the company ID that you created when you signed-up. It will appear on the upper left when logged into CATS.
[transaction_code]: Create and manage transaction codes from within CATS by logging in and clicking on the "Settings" tab, then "User Management" (in the blue bar).
Parameters
Note that parameters can be transmitted through the GET or POST specifications in accordance with HTTP 1.1.

Example using GET: [Base URL]?[parameter]=[value]

Required Parameter Description Type Size
YES data_type candidate, contact, company or joborder. This parameter must be set to qualify the id parameter. string 128
YES id ID # of the record type provided by the data_type parameter. For candidates, use pipeline ID (from get_pipelines). number  
YES status Textual representation of a status to set the record to. string  
  no_activity Set to 'yes' to skip adding an activity record if this is a candidate data_type. string  
  triggers Comma-separated list of IDs for triggers that should be fired. By default no triggers are fired. (See get_statuses for triggers associated with each status.) string  
Example Form
subdomain
transaction_code
data_type

candidate, contact, company or joborder. This parameter must be set to qualify the id parameter.
id

ID # of the record type provided by the data_type parameter. For candidates, use pipeline ID (from get_pipelines).
status

Textual representation of a status to set the record to.
no_activity

Set to 'yes' to skip adding an activity record if this is a candidate data_type.
triggers

Comma-separated list of IDs for triggers that should be fired. By default no triggers are fired. (See get_statuses for triggers associated with each status.)

Copyright ©2012 CATS Software, Inc. All rights reserved.