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...

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>RedCarpet</strong>Using <strong>RedCarpet</strong> MethodsBackground on the <strong>RedCarpet</strong> Methods<strong>RedCarpet</strong> uses an underlying content management engine called “Eprise” to:store the user data, handle the form templates and saved forms, and build andmanage the integrated <strong>RedCarpet</strong> portals. The Eprise content managementdatabase handles all of <strong>RedCarpet</strong>’s content maintenance and security. This istransparent to our users. As an administrator using the <strong>RedCarpet</strong> API, you willuse the Eprise web service to consume methods applicable to <strong>RedCarpet</strong>.<strong>Web</strong> <strong>Service</strong> URLThe web service is referenced with the following URL:https:///eprise/<strong>Web</strong><strong>Service</strong>sA description of the available methods of the Eprise web service is:https:///eprise/<strong>Web</strong><strong>Service</strong>s?WSDL The APIreferences thenaming conventionof the underlyingcontentmanagementengine called“Eprise”. Note: All of your<strong>RedCarpet</strong> pagesare served overSSL.While the majority of these methods do not apply to <strong>RedCarpet</strong>, you may use thispage for verification of applicable methods and their parameters.Logging in to Consume the <strong>Service</strong>While the WSDL is public, consuming the <strong>RedCarpet</strong> services requiresauthentication.The first parameter of each available method is a valid Eprise session id. A validEprise session id is obtained by logging in as a <strong>RedCarpet</strong> employee with thecorrect privileges. It is important to note all <strong>RedCarpet</strong> methods are constrained bythe same security (authentication and authorization) rules as the <strong>RedCarpet</strong> userinterface (performing the same function).Best practice is to log in, execute the applicable methods, then log out. Note: <strong>RedCarpet</strong>role membership(and privilegeassignment) maybe set up by your<strong>RedCarpet</strong>systemsadministrator.Method name: <strong>Login</strong><strong>Login</strong> to obtain a valid session id.• ParametersstrLogInIdValid <strong>Login</strong> ID of a privileged <strong>RedCarpet</strong>employee.stringThe required employee privileges correlateto the privileges required for each methodexecuted.strPassword Corresponding password stringUser Import and Edit 3

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

Saved successfully!

Ooh no, something went wrong!