CitWsAuthorization CitWsInfoStructure CitWsPerson CitWsPrDirectDeposit CitWsTrafficPermits ErrorMessagesHandler generalquery hello persistence statsrecorder WSDOB Unless otherwise specified, web services listed on this site are available for application consumption. Simply click on the "Request Access" link found in the short description for the web service you're interested in. Please send your e-mail with an overview of your planned application that would use an existing web service or a modified version thereof. WS Name: CitWsAuthorization [request access] [request modification] Short WS description: Check authorization permissions. The service allows for multipleID types and multiple authorization types. The default behavior assumes a Kerberos principal (NetID or service srvtab ID) as the ID type and a permit as the authorization type. Categories:   Owner: David Koehler Date registered: March 30, 2004 Current consumers/subscribers: CITWSPerson Additional information: http://pyro.cit.cornell.edu/wsdocs/CitWsAuthorizationDocumentation.rtf https://ws-prod.cit.cornell.edu:8443/wsdl/CitWsAuthorization.wsdl Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): authorization_type (string): Optional. The type of authorization to be checked. The default is "permit". Supported values are: permit authorized (Boolean): Were any of the permissions granted? id (string): Optional. If no ID is supplied, the invocation is assumed to be self-service and the Kerberos principal of the edge user is used. details[] (Struct): Details of permission settings. If check_all was false, only permissions through the first positive result will be checked. id_type (string): Optional. The type of ID provided. The default is "kerberos_principal". Supported values are: kerberos_principal permission (String): Name of the specific permission. check_all (boolean): Optional. Should all permissions be checked or should we return on the first positive? Default: "false". Supported values are: true, false authorized (String): Was this permission granted? Values are: "true", "false", "not checked" permissions[] (array): Array of permissions to be checked. [back to top] WS Name: CitWsInfoStructure [request access] [request modification] Short WS description: The basic function of this service is simply to allow other services to obtain a blank Service Information Structure which can be used to replay to "getServiceInfo" requests. The "getServiceInfo" method (operation) is a required method for "endorsed" web services. Categories:   Owner: David Koehler Date registered: April 12, 2004 Current consumers/subscribers: Additional information: https://uportal.cornell.edu/tag.idempotent.worker.download.target.n77.uP?file=/Consumer%20Documentation/Production%20Web%20Services/CitWsInfoStructure.rtf&action=open http://cfprod.cit.cornell.edu/WSDLRepositoryParser/displaywsdl.cfm?wsdlname=CitWsInfoStructure.wsdl http://cfprod.cit.cornell.edu/WSDLRepositoryParser/displaywsdl.cfm?wsdlname=CitWsInfoStructure.wsdl Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): getInformationStructure options (array): Any element in the array will be echoed in the "Parameter_Information" attribute of the Service Information Structure. getServiceInfo options (array): Any element in the array will be echoed in the "Parameter_Information" attribute of the Service Information Structure. [back to top] WS Name: CitWsPerson [request access] [request modification] Short WS description: A webService provided to return identifiers, bio-demo data, job information and relationship status indicators. Categories:     Owner: David Koehler Date registered: March 22, 2004 Current consumers/subscribers: DFA Travel Reimbursement application Additional information: https://uportal.cornell.edu/tag.idempotent.worker.download.target.n77.uP?file=/Consumer%20Documentation/Production%20Web%20Services/CitWsPerson%20Documentation.rtf&action=open https://uportal.cornell.edu/tag.idempotent.worker.download.target.n77.uP?file=/Core%20Development%20Team/Data%20Administration/CitWsPerson/CitWsPerson.doc&action=open http://cfprod.cit.cornell.edu/WSDLRepositoryParser/displaywsdl.cfm?wsdlname=CitWsPerson.wsdl Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): Net ID (array): Net ID. Optional. If no netid is supplied, the invocation is assumed to be self-service. Net ID (string): NetId for whom data was retrieved. ssn (String): SSN for the individual. emplid (String): String SSNfor the individual. lastName (String): Primary (legal) last name. firstName (String): Primary (legal) first name. middleName (String): Primary (legal) middle name. campusPhone (String): Self-reported campus phone number(s). campusAddress (String): Self-reported campus address. offCampusWorkPhone (String): Self-reported off-campus work phone number non-student. offCampusWorkAddress (String): Self-reported off-campus work address ñ non-student. studentResidencePhone (String): Student residence phone. studentResidenceAddress (String): Student residence address. uri (String): Self-reported personal URL. deptid (string): HR department code from Primary job. deptName (String): HR department name based on department code from Primary job. jobCode (String): HR job code from Primary job. univTitle (String): HR university title based on job code from Primary job. isEmployee (Boolean): Excluding student hourly, is there an 'active' Primary job? isAcademic (Boolean): Is there any 'active' academic job? isProfessorial (Boolean): Is there any 'active' professorial job? isAssistant (Boolean): Is there any grad assistant job? isExecutive (Boolean): Is there any 'active' executive level job? isStudent (Boolean): Is the person a registered student? (Only valid for fall and spring semesters). isKeyFound (Boolean): Was the NetID found in the alias file? isNetidDisabled (Boolean): Is the NetIDdisabled in the system? [back to top] WS Name: CitWsPrDirectDeposit [request access] [request modification] Short WS description: A webService provided to return identifiers and a Direct Deposit status indicator Categories:     Owner: Date registered: March 22, 2004 Current consumers/subscribers: DFA Travel Reimbursement application Additional information: http://cfprod.cit.cornell.edu/WSDLRepositoryParser/documentation/SpecificDocuments/CitWsTrafficPermits.Documentation.rtf Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): Net ID (array): Net ID. Optional. If no netid is supplied, the invocation is assumed to be self-service. Net ID (string): NetId for whom data was retrieved. emplid (String): The PS EmplID associated in the PS system with the Net ID parameter. hasDirectDeposit (Boolean): true / false, does the person currently have direct deposit. Flag is returned independent of job status. retCode (String) errMsg (String) [back to top] WS Name: CitWsTrafficPermits [request access] [request modification] Short WS description: Get basic traffic permit(s) information for a member of the Cornell Community. Categories:     Owner: Date registered: July 23, 2004 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/WSDLRepositoryParser/documentation/SpecificDocuments/CitWsTrafficPermits.Documentation.rtf Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): Net ID (array): Net ID. Optional. If no netid is supplied, the invocation is assumed to be self-service. ID (String): Traffice ID for whom data was retrieved. Name (String): Name for the individual errorMsg (String): Error message returned, if any. permitCount (String): Count of permits returned. Permits (Array): Array of structures for each Permit (below). Permit (String): Permit ID. Tier (String): This permit's tier Effective_Date (String): Effective date. Void_Date (String): Void date. Owner (String): Is this the owner of the permit [yes/no]. Memory_Text (Array): Memory tool text list, if any. Special_Area (Array): Special areas list, if any. [back to top] WS Name: ErrorMessagesHandler [request access] [request modification] Short WS description: Tracks Errors by Applications providing displayable messages for the users and possible technical information related to the error. Categories:     Owner: David Koehler Date registered: April 12, 2004 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/cfide/componentutils/componentdetail.cfm?component=CITWS.ErrorMessagesHandler#method_getServiceInfo Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): getServiceInfo see CitWSInfoStruct see CitWSInfoStruct see CitWSInfoStruct GrabErrorRecord ProxyID (String): Application (String): ErrorMessage (String): lookup Looks up the specificed error and returns all recorded information about the error Application (String): ErrorMessage (String): parseDate theDate (Date): [back to top] WS Name: generalquery [request access] [request modification] Short WS description: Runs queries Categories:     Owner: David Koehler Date registered: January 5, 2005 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/cfide/componentutils/componentdetail.cfm?component=CITWS.GeneralQuery Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): Authorized ListOfPermits (String): Required. List of permits Net ID (String): Required. Net ID getBlankResultSet getDNSStruct getDSNandQueryIDs determine the Datasource ID and the Query ID of names. dbName (String): Required. dbName sqlName (String): Required. sqlName getDSNInformation Returns infomation about named DataSources; this information included details about named queries. If a datasouce name is not provided, all datasources are returned. dsnames (Array): Required. Dsnames getParamtersFromQuery query (String): Required. Query getPersist getQueryStruct getServiceInfo see CitWSInfoStruct see CitWSInfoStruct see CitWSInfoStruct getUserInfo Net ID (String): Required. Net ID getValueFromProperties Returns value if found but empty string if not. key (String): Required. Key of the value we are looking for. data (Struct): Required. Struc returned from the persistence call. LocalRecord Record use of WS. methodname (String): Required. Methodname parm1 (String): Optional. Parm1 parm2 (String): Optional. Parm2 LookupErrorMessage ErrMsg (String): Required. ErrMsg parseStoreProcInfo qry (String): Required. Qry persist data (Array): Required. Array of persistence KVPs. runquery Executes a query and returns results. requestInfo (Struct): Required. requestInfo [back to top] WS Name: hello [request access] [request modification] Short WS description: Says hi. Has/can been used to illustrate web service functionality. Categories:     Owner: David Koehler Date registered: April 12, 2004 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/cfide/componentutils/componentdetail.cfm?component=CITWS.hello Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): displayProxyID echo sendbacktorequester (String): Required. Sendbacktorequester echoHost getServiceInfo see CitWSInfoStruct see CitWSInfoStruct see CitWSInfoStruct hello [back to top] WS Name: persistence [request access] [request modification] Short WS description: Stores and retreives key/value pairs (KVPs) by enforced unique name (Key). Keys are supplemented by proxy_id and netid to ensure uniqueness: meaning two applications may use the same "key" name without overwriting each others data. Categories:     Owner: David Koehler Date registered: September 28, 2004 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/cfide/componentutils/componentdetail.cfm?component=CITWS.persistence Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): get Return unique named KVPs. KVPs are stored in an array in the "data" element of the returned structure: each element of the array contains a struct with the elements "key" and "value". key (String): Required. Name of the key of the KVPs: e.g. "ColtsSettings" getKVPStruct getProxyInfo Returns the proper proxyid, this is to ensure backward compatibility with CORBA. key (String): Required. Key getReturnStruct getServiceInfo see CitWSInfoStruct see CitWSInfoStruct see CitWSInfoStruct grab key (String): Required. Key LocalRecord Record use of WS. methodname (String): Required. Methodname LookupErrorMessage ErrMsg (String): Required. ErrMsg parseKVPs data (Array): Required. Array of persistence KVPs. set Set/Save/Store the information in a DB, uniquely, so that it persists. KVPs are stored in an array in the "data" element of the returned structure: each element of the array contains a struct with the elements "key" and "value". key (String): Required. Name of the key of the KVPs: e.g. "ColtsSettings" kvpairs (Array): Required. An Array of structs. The struct must contain the elements "key" and "value". store Set/Save/Store the information in a DB, uniquely, so that it persists. KVPs are not returned. key (String): Required. Name of the key of the KVPs: e.g. "ColtsSettings" kvpairs (Array): Required. An Array of structs. The struct must contain the elements "key" and "value". stuff key (String): Required. Name of the key of the KVPs: e.g. "ColtsSettings" kvpairs (Array): Required. An Array of structs. The struct must contain the elements "key" and "value". [back to top]   WS Name: statsrecorder [request access] [request modification] Short WS description: Records statistics. This is for use with the cf_kwsinvoke tag. Result sets are returned as multiref structs. Categories: Owner: David Koehler Date registered: April 6, 2004 Current consumers/subscribers: Additional information: http://cfprod.cit.cornell.edu/cfide/componentutils/componentdetail.cfm?component=CITWS.statsrecorder Operations / Methods: Operation / Method Description: Parameter(s) & business definition(s): Output(s) & business definition(s): getServiceInfo see CitWSInfoStruct see CitWSInfoStruct see CitWSInfoStruct LocalRecord methodname (String): Required. Methodname LookupErrorMessage ErrMsg (String): Required. ErrMsg Record RollOverTimeFrame (String): Required. RollOverTimeFrame Application (String): Required. Application Key (String): Required. Key RecordIncrementByValue Increments by specified value RollOverTimeFrame (String): Required. RollOverTimeFrame Application (String): Required. Application Key (String): Required. Key Rvalue (String): Required. Rvalue RecordSpecificValue RollOverTimeFrame (String): Required. RollOverTimeFrame Application (String): Required. Application Key (String): Required. Key Rvalue (String): Required. Rvalue RecordSpecificValueAndDate Application (String): Required. Application Key (String): Required. Key Rvalue (String): Required. Rvalue Rdate (String): Required. Rdate UpdateTally Application (String): Required. Application Key (String): Required. Key RollOverTimeFrame (String): Required. RollOverTimeFrame Value (String): Required. Value UpdateTallyBy Increment by specific value Application (String): Required. Application Key (String): Required. Key RollOverTimeFrame (String): Required. RollOverTimeFrame Value (String): Required. Value [back to top] WS Name: WSDOB [request access] [request modification] Short WS description: Look up Date Of Birth in PS and SIS associated with the Net ID parameter. Executes a Select statement against PS, then invokes CUSSP command SIGDOB. Intended for use ONLY by Identity Management for a limited time. Categories: Not Endorsed Single Use Data Certified     Owner: Andrea Beesing Date registered: June 21, 2005 Current consumers/subscribers: Credentials Management Service Additional information: http://cfprod-webdav.cit.cornell.edu/WebServicesSupport/Documentation/CitWsDOB_Documentation.rtf Parameters: netid String NetID for which the DOB is desired Outputs: netid String NetID (same as the input parameter) errorcd String Error code as defined in specification errmsg String Error message, if any (usually null) psdob String Date of birth from PS sisdob String Date of birth from SIS