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>• The requirements of the LaunchEvent method differ from the UpdateEventmethod. The rules are outlined with each event.Field Descriptions of the xmlEventDataThe second parameter of each Event method is an XML document passed as asimple string. The string contains an Events record with the following generalformat:Note: See below foradditionalinformation on tagsfor events.• The root element is .• The parent element, occurs once for each event to be launched.The record is composed of two parts:1The child element must contain one of the unique user identifiers describedbelow.2Child and subchild elements to populate or update the event fields as definedon the event definitions. The syntax to match the event definition isdescribed below.Details of the Input recordTwo parts of the input record are:Part One: an element to uniquely identify an employee to benefit from the event orthe event update.You may one of choose from three techniques to uniquely identify an employee forLaunchEvent and UpdateEvent. Three techniques are available for backwardcompatibility.1 Four elements are provided to choose from. The naming convention ofelements used for unique identifiers are prefixed with “ForWhom_”. The recordshould contain only one of these options. If you are using an externalapplication to authenticate your users, <strong>SilkRoad</strong> recommends you useForWhom_AuthParam to identify each user.Note: <strong>SilkRoad</strong>recommends usingtheForWhom_AuthParam“ForWhom” IdentifierForWhom_<strong>Login</strong>IdForWhom_AuthParamForWhom_EmailForWhom_GuidDescription<strong>RedCarpet</strong> <strong>Login</strong>Id for employees using StandardAuthentication<strong>Login</strong>ID for employees using External Authenticationemployee Email address if the employee email address isunique.<strong>RedCarpet</strong> creates and stores a GUID for each employee.This value is returned from GetUserProfileEx method.User Import and Edit 36

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

Saved successfully!

Ooh no, something went wrong!