Web Service Guide - RedCarpet - Login - SilkRoad Technology

Recommendations

Info

RedCarpetFor customers with a high volume of events SilkRoad does not recommendusing the GetEventReport or GeEventReportEx methods to obtain employeeuser profile and task data information. See GetUserIDList, GetUserProfileEx2and GetTask methods for additional information.GetEventReportUsageUsed to generate XML output using the same parameters available in theRedCarpet user interface.The columns included in the report output are specified in the RedCarpet userinterface Settings page.ParametersPlease note the strStartingDate and strEndingDate parameters have a defaultvalue to limit the data being returned.strSecurityTokenRequired.simple stringValid Session ID for consuming serviceincludes the Reports privilegestrEventName Optional. simple stringarrCategoryFilterOptionalUsed to specify the benefiter’s categoryvalues associated with the event.stringArrayOfArrayOfString"" - (empty string) - all categories will bereturned .valid values match the strings as specifiedon the Manage Hierarchical CategoryValues under Administration -> ManageCategories page in the RedCarpet userinterface. See “Syntax of the CategoryParameter” on page 98.Web Service 134
RedCarpetstrStartingDateOptionalstringOptional. Used to specify the start of a daterange. The date range queries the effectivedate of the event.If srtStartingDate is not specified it willdefaul to yesterday.StrEndingDateA string in yyyy-mm-dd format.OptionalstringOptional. Used to specify the end of a daterange. The date range queries the effectivedate of the event.If srtEndingDate is not specified it willdefaul to todayA string in yyyy-mm-dd format.ReturnsA table of type EpsStringEx.The structure is:EpsStringEx{String ErrorString;int ErrorNum;String Data;}ErrorStringReturn code description. The value of ErrorNum should be checked for a thevalue not equal to 1 to determine an error description vs. a success message.““ or “xxxx” — return code descriptionErrorNumThis variable indicates success or failure. Values are:Data1 (one) — method succeeded0 (zero) — method failedWeb Service 135
Page 1 and 2:
Web Service GuideVersion 2014.3.0
Page 3 and 4:
RedCarpetTable of ContentsRedCarpet
Page 5 and 6:
RedCarpetRedCarpet WebServiceOvervi
Page 7 and 8:
RedCarpetUsing RedCarpet MethodsBac
Page 9 and 10:
RedCarpet• Returns1 — successfu
Page 11 and 12:
RedCarpet• LoginID - required for
Page 13 and 14:
RedCarpet• E-Verify Case data (Re
Page 15 and 16:
RedCarpetReturnsAn XML document def
Page 17 and 18:
RedCarpetGetUserIDList Error Messag
Page 20 and 21:
RedCarpetNode Description NotesID t
Page 22 and 23:
RedCarpetSample OutputNo Error1Tamm
Page 24 and 25:
RedCarpet96607afd-293f-42be-b85dfa6
Page 26 and 27:
RedCarpet““ or “xxxx” — r
Page 28 and 29:
RedCarpet+ HR CoordinatorHarry Wise
Page 30 and 31:
RedCarpetReturn code description. T
Page 32 and 33:
RedCarpet4478e4cc00a5-79a4-4c47-801
Page 34 and 35:
RedCarpetThe structure is:EpsString
Page 36 and 37:
RedCarpetJane BrownJohn SmithUpload
Page 38 and 39:
RedCarpetCode examplesTo update an
Page 40 and 41:
RedCarpet• The requirements of th
Page 42 and 43:
RedCarpetA description of event fie
Page 44 and 45:
RedCarpetNon-category field syntax:
Page 46 and 47:
RedCarpetLaunchEvent MethodLoginIDJ
Page 48 and 49:
RedCarpetParametersstrSecurityToken
Page 50 and 51:
RedCarpetOnboarding-EVerify440 even
Page 52 and 53:
RedCarpet ValueValueValueDescriptio
Page 54 and 55:
RedCarpetErrorNumThis variable indi
Page 56 and 57:
Page 58 and 59:
RedCarpetTask APIsFour methods are
Page 60 and 61:
RedCarpetIf one or more parameters
Page 62 and 63:
RedCarpetElement Syntax Value Descr
Page 64 and 65:
RedCarpetstrForWhomUserstring strEv
Page 66 and 67:
RedCarpetA sample return is as foll
Page 68 and 69:
RedCarpetDeleteTask MethodUsageUsed
Page 70 and 71:
RedCarpetDataA record will be retur
Page 72 and 73:
Page 74 and 75:
RedCarpetExamples of GetTasks strXM
Page 76 and 77:
RedCarpetNode Description Notes Occ
Page 78 and 79:
RedCarpetThe elements of the record
Page 80 and 81:
RedCarpetIf an employee is returned
Page 82 and 83:
RedCarpetCompleteTaskExUsageComplet
Page 84 and 85:
RedCarpetNode Description NotesType
Page 86 and 87:
RedCarpetMethod ReturnsAn XML docum
Page 88 and 89: RedCarpetErrorNot authorized to com
Page 90 and 91: RedCarpet• if the form has previo
Page 92 and 93: RedCarpetUsage and Parameters of Ge
Page 94 and 95: RedCarpetNode Description Notes Par
Page 96 and 97: RedCarpetNode Description NotesOpti
Page 98 and 99: RedCarpetTo return all completed ex
Page 100 and 101: RedCarpet1ObjectIdForm_TypeOwnerCom
Page 102 and 103: RedCarpetwes.rogerswrogers@MySRT.co
Page 104 and 105: RedCarpetstrFKUserIDstrFormTypestrD
Page 106 and 107: RedCarpetstrDeliveredstrEventNamear
Page 108 and 109: RedCarpetDataA string array contain
Page 110 and 111: RedCarpetDataA string containing th
Page 112 and 113: RedCarpetMark a Form as DeliveredA
Page 114 and 115: RedCarpetIn 2.7.x the process flow
Page 116 and 117: RedCarpetEpsStringEx{String ErrorSt
Page 118 and 119: RedCarpetCode exampleRetrieve the c
Page 120 and 121: RedCarpetCode exampleTo delete a sp
Page 122 and 123: RedCarpetNode Description Notes Opt
Page 124 and 125: RedCarpetI9UploadTo get all documen
Page 126 and 127: RedCarpet]]>GetUploadedDocumentUsag
Page 128 and 129: RedCarpetChapter 5: CategoryUploadO
Page 130 and 131: RedCarpetCode examplesTo import new
Page 132 and 133: RedCarpetValue'Update' and 'Replace
Page 134 and 135: RedCarpetExample Structure of GetEv
Page 136 and 137: RedCarpetNode Description NotesOpti
Page 140 and 141: RedCarpetString containing XML reco
Page 142 and 143: RedCarpetChapter 7: UsingTransforma
Page 144 and 145: RedCarpetMethods Supporting Transfo
Page 146 and 147: RedCarpetAppendix ASample CodeListe
Page 148 and 149: RedCarpetfor (int i = 1 ; i < t.Dat
show all

Web Service Guide - RedCarpet - Login - SilkRoad Technology

Create successful ePaper yourself

Delete template?

Save as template?