Candidate Resume Data API

Size: px

Start display at page:

Download "Candidate Resume Data API"

Dale Hunter
5 years ago
Views:

1 Candidate Resume Data API Version 1.03 gradleaders.com

2 Table of Contents TABLE OF CONTENTS OVERVIEW... 1 EXAMPLE CODE... 1 WEB SERVICE... 1 Invocation Result... 1 Configuration... 1 Method Save... 2 Method Get... 3 Method GetModified... 4 WSDL... 4 i

3 OVERVIEW This document provides comprehensive specifications for the GradLeaders Candidate Resume Data API. The guide aims to help developers quickly understand and integrate this web service. EXAMPLE CODE An example code project that demonstrates all functionality is available upon request. This example project has been implemented as Console application written in C#.NET v4.0 using Visual Studio.NET WEB SERVICE This web service contains methods for adding Candidate Resume data in GradLeaders Career Center as well as retrieving both new and modified records. Invocation Result All methods for this web service return a complex type object that describes the overall result of the invocation, in addition to any requested data or validation errors. Please refer to the WSDL at the end of this file for specific technical information for each method. The Result contains important information that should be checked by the consumer after every invocation. The Overall Result will contain one of the following results: No Data Indicates that no data was returned from a Fetch method. Complete Success Indicates that the method was 100% successful in the requested operation. Partial Success Indicates that the some of the requested modifications did not succeed as a result of validation Errors, etc. Total Failure Indicates that the entire operation was unsuccessful. Exception Indicates that the web service encountered a critical error that will require GradLeaders Support to investigate. In addition to the Overall Result, a Detail Result will be return that contains individual validation errors or fetch results. See WSDL for specific technical information. Configuration There are a few key pieces of information that you will need in order to implement this web service. The first two values are provided to you by GradLeaders Career Center. 1

4 Web Service End Point this is the GradLeaders Career Center URL where the web services is located, example: Integration Key this is a special key that allows you to consume the web service. This identifies you as a trusted consumer of the web service any value other than one provided to you will be blocked from using the service. Allowed Remote IP Addresses this is list of IP address that will be allowed to consume the GradLeaders web service. Any IP address not in this will be blocked from using the service. Method Save This method is used to add Candidate Resume records. Candidate Resume Object (bold/red are required) Candidate Address ResumeTitle UploadDate ResumeFilename Document (byte array) IsDefaultResume Parameters Integration Key the value described in the Configuration section above. CandidateResume the Candidate Resume object to add. Validations Integration Key Remote IP Candidate Address is not blank Candidate Address is valid/well-formed Candidate Address exists Candidate has default profile Resume Title is not blank Upload Date is not empty and is greater than 1/1/001 Resume Filename is not blank Resume Filename is well-formed Resume Document is supplied Resume Document is no a zero-length file Resume Document is not larger than 1MB Resume Document can be written to disk Resume Document can be processed by RealResume Result Detail: an array of Candidate Resume Data Change (see WSDL). 2

5 Each Detail Result will contain one of the following Results (see WSDL): Successfully Created Indicates that the record was successfully created. Successfully Updated Indicates that the record was successfully updated. Already Exists Therefore Ignored if the parameter Update If Exists was supplied with a false value, this Indicates that the record already exists in GradLeaders Career Center and was not updated. Validation Errors Indicates that the record had validation errors Method Get This method is used to retrieve a list of new Candidate Resumes added to GradLeaders Career Center within the specified criteria. Candidate Resume Data Fetch Object Candidate Address ResumeTitle UploadDate ResumeFilename Document (byte array) IsDefaultResume GTSReadOnly_ResumeID GTSReadOnly_CreatedDate GTSReadOnly_CreatedBy GTSReadOnly_UpdatedDate GTSReadOnly_UpdatedBy Parameters Integration Key the value described in the Configuration section above. From Date the start date in which to retrieve new candidates. This is inclusive of the supplied date. Through Date the end date in which to retrieve new candidates. This is NON-INCLUSIVE of the supplied date. Validations Integration Key Remote IP Get Limit (500 records) not exceeded Result Detail: an array of Candidate Resume Data Fetch (see WSDL). 3

6 Method GetModified This method is used to retrieve a list of modified Candidate Resumes in GradLeaders Career Center within the specified criteria. Candidate Data Fetch Object Candidate Address ResumeTitle UploadDate ResumeFilename Document IsDefaultResume GTSReadOnly_ResumeID GTSReadOnly_CreatedDate GTSReadOnly_CreatedBy GTSReadOnly_UpdatedDate GTSReadOnly_UpdatedBy Parameters Integration Key the value described in the Configuration section above. From Date the start date in which to retrieve new candidates. This is inclusive of the supplied date. Through Date the end date in which to retrieve new candidates. This is NON-INCLUSIVE of the supplied date. Include New a Boolean value to indicate if Candidate created within the supplied date range should be returned in the results. Validations Integration Key Remote IP Get Limit (500 records) not exceeded Result Detail: an array of Candidate Resume Data Fetch (see WSDL). WSDL The actual WSDL URL for your Beta/Production GradLeaders Career Center website will be provided to you. Here is an example of what it contains: <?xml version="1.0" encoding="utf-8"?> 4

7 <wsdl:definitions xmlns:tm=" xmlns:soapenc=" xmlns:mime=" xmlns:tns=" xmlns:soap=" xmlns:s=" xmlns:soap12=" xmlns:http=" targetnamespace=" xmlns:wsdl=" <wsdl:types> <s:schema elementformdefault="qualified" targetnamespace=" <s:element name="save"> <s:element minoccurs="0" maxoccurs="1" name="integrationkey" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="candidateresume" type="tns:candidateresume" /> <s:complextype name="candidateresume"> <s:element minoccurs="0" maxoccurs="1" name="candidate address" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="resumetitle" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="uploaddate" type="s:datetime" /> <s:element minoccurs="0" maxoccurs="1" name="resumefilename" type="s:string" /> <s:element minoccurs="0" maxoccurs="1" name="document" type="s:base64binary" /> <s:element minoccurs="1" maxoccurs="1" name="isdefaultresume" type="s:boolean" /> <s:element name="saveresponse"> <s:element minoccurs="0" maxoccurs="1" name="saveresult" type="tns:resultofcandidateresumedatachange" /> <s:complextype name="resultofcandidateresumedatachange"> <s:element minoccurs="1" maxoccurs="1" name="overallresult" type="tns:resulttypes" /> <s:element minoccurs="0" maxoccurs="1" name="overallresultmessages" type="tns:arrayofstring" /> <s:element minoccurs="0" maxoccurs="1" name="detailresults" type="tns:arrayofcandidateresumedatachange" /> <s:simpletype name="resulttypes"> <s:restriction base="s:string"> <s:enumeration value="nodata" /> <s:enumeration value="completesuccess" /> <s:enumeration value="partialsuccess" /> <s:enumeration value="totalfailure" /> <s:enumeration value="exception" /> 5

8 </s:restriction> </s:simpletype> <s:complextype name="arrayofstring"> <s:element minoccurs="0" maxoccurs="unbounded" name="string" nillable="true" type="s:string" /> <s:complextype name="arrayofcandidateresumedatachange"> <s:element minoccurs="0" maxoccurs="unbounded" name="candidateresumedatachange" nillable="true" type="tns:candidateresumedatachange" /> <s:complextype name="candidateresumedatachange"> <s:element minoccurs="0" maxoccurs="1" name="candidate address" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="result" type="tns:detailresulttypes" /> <s:element minoccurs="0" maxoccurs="1" name="validationerrors" type="tns:arrayofstring" /> <s:simpletype name="detailresulttypes"> <s:restriction base="s:string"> <s:enumeration value="successfullycreated" /> <s:enumeration value="successfullyupdated" /> <s:enumeration value="alreadyexiststhereforeignored" /> <s:enumeration value="validationerrors" /> </s:restriction> </s:simpletype> <s:element name="getnew"> <s:element minoccurs="0" maxoccurs="1" name="integrationkey" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="fromdate" type="s:datetime" /> <s:element minoccurs="1" maxoccurs="1" name="throughdate" type="s:datetime" /> <s:element name="getnewresponse"> <s:element minoccurs="0" maxoccurs="1" name="getnewresult" type="tns:resultofcandidateresumedatafetch" /> <s:complextype name="resultofcandidateresumedatafetch"> <s:element minoccurs="1" maxoccurs="1" name="overallresult" type="tns:resulttypes" /> <s:element minoccurs="0" maxoccurs="1" name="overallresultmessages" type="tns:arrayofstring" /> <s:element minoccurs="0" maxoccurs="1" name="detailresults" type="tns:arrayofcandidateresumedatafetch" /> 6

9 <s:complextype name="arrayofcandidateresumedatafetch"> <s:element minoccurs="0" maxoccurs="unbounded" name="candidateresumedatafetch" nillable="true" type="tns:candidateresumedatafetch" /> <s:complextype name="candidateresumedatafetch"> <s:complexcontent mixed="false"> <s:extension base="tns:candidateresume"> <s:element minoccurs="1" maxoccurs="1" name="gtsreadonly_resumeid" type="s:int" /> <s:element minoccurs="1" maxoccurs="1" name="gtsreadonly_createddate" type="s:datetime" /> <s:element minoccurs="0" maxoccurs="1" name="gtsreadonly_createdby" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="gtsreadonly_updateddate" type="s:datetime" /> <s:element minoccurs="0" maxoccurs="1" name="gtsreadonly_updatedby" type="s:string" /> </s:extension> </s:complexcontent> <s:element name="getmodified"> <s:element minoccurs="0" maxoccurs="1" name="integrationkey" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="fromdate" type="s:datetime" /> <s:element minoccurs="1" maxoccurs="1" name="throughdate" type="s:datetime" /> <s:element minoccurs="1" maxoccurs="1" name="includenew" type="s:boolean" /> <s:element name="getmodifiedresponse"> <s:element minoccurs="0" maxoccurs="1" name="getmodifiedresult" type="tns:resultofcandidateresumedatafetch" /> </s:schema> </wsdl:types> <wsdl:message name="savesoapin"> <wsdl:part name="parameters" element="tns:save" /> <wsdl:message name="savesoapout"> <wsdl:part name="parameters" element="tns:saveresponse" /> <wsdl:message name="getnewsoapin"> <wsdl:part name="parameters" element="tns:getnew" /> <wsdl:message name="getnewsoapout"> <wsdl:part name="parameters" element="tns:getnewresponse" /> 7

10 <wsdl:message name="getmodifiedsoapin"> <wsdl:part name="parameters" element="tns:getmodified" /> <wsdl:message name="getmodifiedsoapout"> <wsdl:part name="parameters" element="tns:getmodifiedresponse" /> <wsdl:porttype name="candidateresumedatasoap"> <wsdl:operation name="save"> <wsdl:input message="tns:savesoapin" /> <wsdl:output message="tns:savesoapout" /> <wsdl:operation name="getnew"> <wsdl:input message="tns:getnewsoapin" /> <wsdl:output message="tns:getnewsoapout" /> <wsdl:operation name="getmodified"> <wsdl:input message="tns:getmodifiedsoapin" /> <wsdl:output message="tns:getmodifiedsoapout" /> </wsdl:porttype> <wsdl:binding name="candidateresumedatasoap" type="tns:candidateresumedatasoap"> <soap:binding transport=" /> <wsdl:operation name="save"> <soap:operation soapaction=" <wsdl:operation name="getnew"> <soap:operation soapaction=" <wsdl:operation name="getmodified"> <soap:operation soapaction=" </wsdl:binding> <wsdl:binding name="candidateresumedatasoap12" type="tns:candidateresumedatasoap"> 8

11 <soap12:binding transport=" /> <wsdl:operation name="save"> <soap12:operation soapaction=" <wsdl:operation name="getnew"> <soap12:operation soapaction=" <wsdl:operation name="getmodified"> <soap12:operation soapaction=" </wsdl:binding> <wsdl:service name="candidateresumedata"> <wsdl:port name="candidateresumedatasoap" binding="tns:candidateresumedatasoap"> <soap:address location=" /> </wsdl:port> <wsdl:port name="candidateresumedatasoap12" binding="tns:candidateresumedatasoap12"> <soap12:address location=" /> </wsdl:port> </wsdl:service> </wsdl:definitions> 9

Calendar Data API. Version gradleaders.com

Calendar Data API. Version gradleaders.com Version 1.03 gradleaders.com Table of Contents 614.791.9000 TABLE OF CONTENTS Overview... 1 Example Code... 1 Web Service... 1 Invocation Result... 1 Configuration... 1 Method - GetCustomFields... 2 Method