10.07.2015 Views

Web Service Guide - RedCarpet - Login - SilkRoad Technology

Web Service Guide - RedCarpet - Login - SilkRoad Technology

Web Service Guide - RedCarpet - Login - SilkRoad Technology

SHOW MORE
SHOW LESS
  • No tags were found...

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>RedCarpet</strong><strong>RedCarpet</strong> <strong>Web</strong><strong>Service</strong>Overview<strong>RedCarpet</strong> provides a web service for administrators to takeadvantage of <strong>RedCarpet</strong> features through an API. <strong>RedCarpet</strong>methods exist in these general categories of features:1 An interface to retrieve <strong>RedCarpet</strong> user information2 An interface to perform a user import and edit3 An interface for LifeCycle events and forms.4 An interface for Category Uploads.Methods to Retrieve Employee DataFour methods are available to retrieve employee data. Onemethod returns a list of <strong>RedCarpet</strong> user ids and the other threeaccept a user id and return data about the specified user. The<strong>RedCarpet</strong> method to return a list of user ids is available toretrieve all the users in the system or just the users that havemodified since the last retrieval.Three <strong>RedCarpet</strong> methods are available to retrieve <strong>RedCarpet</strong>employee information based on user id. All three methodsprovide detailed output including employee profile data, extendeduser profile (custom) data, key property attributes, assignmentcategory attributes, team membership, and event information.One method outputs string arrays and the other two usermethods output an XML record.Methods to Import and Update EmployeeData<strong>RedCarpet</strong> allows new users to be created and existing users tobe edited through a user import. An import method is provided tocreate new users (with or without a lifecycle event) and an editmethod is provided for existing users.The <strong>RedCarpet</strong> user import feature can be used for allemployees. New employees can be created as pending userswith very minimal information. Pending users are then reviewed, Employees can be imported tobenefit from an event and /or tocomplete tasks on behalf of anotheremployee.<strong>Web</strong> <strong>Service</strong> 1

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!