Embed Size (px)
Citation preview
HUMAN CAPITAL SCORE™
WEB SERVICE INTERFACE DOCUMENT
This document provides a high level explanation of the public facing web interface to get the Human Capital Score™.
© People Capital, 2010
~ 1 ~
CONTENTS Introduction ......................................................................................................................... 4
Human Capital Score™ Web Service ............................................................................. 4
People Capital’s Human Capital Score™ output provides: ............................................ 4
Key Benefits to the User ............................................................................................. 4
Key Benefits to the Company ..................................................................................... 5
Summary ............................................................................................................................. 6
Connection .......................................................................................................................... 6
Services ............................................................................................................................... 7
HCSCreditScoreLookupWcf.svc .................................................................................... 7
HCSCreditScoreWcf.svc ................................................................................................ 7
Appendix ............................................................................................................................. 9
Services ........................................................................................................................... 9
HcsCreditScoreLookupWcf ........................................................................................ 9
HcsCreditScoreWcf .................................................................................................... 9
Service Contracts .......................................................................................................... 10
HcsCreditScore ......................................................................................................... 10
HcsCreditScoreLookup ............................................................................................. 10
Operations ..................................................................................................................... 11
CalculateScore .......................................................................................................... 11
GetCreditScoreResults .............................................................................................. 11
GetCurrentVersion .................................................................................................... 11
GetSchoolInfo ........................................................................................................... 11
GetTestInfo ............................................................................................................... 12
GetAddressTypeInfo ................................................................................................. 12
GetDegreeInfo........................................................................................................... 12
GetSchoolLevelInfo .................................................................................................. 12
GetFieldOfStudyInfo ................................................................................................ 12
GetSchoolDegreeInfo ............................................................................................... 13
Messages ....................................................................................................................... 13
CalculateScoreMsgRequest ...................................................................................... 13
CalculateScoreMsgResult ......................................................................................... 13
GetCreditScoreResultsMsgRequest .......................................................................... 13
GetCreditScoreResultsMsgResult............................................................................. 13
GetCurrentVersionMsgRequest ................................................................................ 14
~ 2 ~
GetCurrentVersionMsgResult................................................................................... 14
GetSchoolInfoMsgRequest ....................................................................................... 14
GetSchoolInfoMsgResult .......................................................................................... 14
GetTestsInfoMsgRequest .......................................................................................... 14
GetTestsInfoMsgResult ............................................................................................ 14
GetAddressTypeMsgRequest ................................................................................... 14
GetAddressTypeMsgResult ...................................................................................... 14
GetDegreeMsgRequest ............................................................................................. 15
GetDegreeMsgResponse ........................................................................................... 15
GetSchoolLevelMsgRequest..................................................................................... 15
GetSchoolLevelMsgResponse .................................................................................. 15
GetFieldOfStudyMsgRequest ................................................................................... 15
GetFieldOfStudyResponse ........................................................................................ 15
GetSchoolDegreeMsgRequest .................................................................................. 15
GetSchoolDegreeMsgResponse ................................................................................ 15
Data Contract ................................................................................................................ 17
CreditScoreRequest................................................................................................... 17
PersonalAddressCollection ....................................................................................... 17
SchoolCollection ....................................................................................................... 17
TestCollection ........................................................................................................... 17
PersonalInfo .............................................................................................................. 17
PersonalAddress ........................................................................................................ 17
Test ............................................................................................................................ 17
School ....................................................................................................................... 18
FieldOfStudyCollection ............................................................................................ 18
FieldOfStudy ............................................................................................................. 18
CreditScoreResult ..................................................................................................... 18
IncomeProjectionCollection ..................................................................................... 18
IncomeProjection ...................................................................................................... 18
HCSScoreCollection ................................................................................................. 18
HCSScore .................................................................................................................. 18
LookupGetInfo .......................................................................................................... 19
LookupCurrentHCSVersion ..................................................................................... 19
LookupTestCollection............................................................................................... 19
LookupTest ............................................................................................................... 19
~ 3 ~
LookupFieldOfStudyCollection ................................................................................ 19
LookupFieldOfStudy ................................................................................................ 19
LookupSchoolCollection .......................................................................................... 19
LookupSchool ........................................................................................................... 19
LookupSchoolDegreeCollection ............................................................................... 19
LookupSchoolDegree ............................................................................................... 19
LookupAddressTypeCollection ................................................................................ 20
LookupAddressType ................................................................................................. 20
LookupDegreeCollection .......................................................................................... 20
LookupDegree........................................................................................................... 20
LookupSchoolLevelCollection ................................................................................. 20
LookupSchoolLevel .................................................................................................. 20
FaultContracts ............................................................................................................... 22
CalcValidationError .................................................................................................. 22
CreditScoreResultFault ............................................................................................. 22
GeneralFaultDC ........................................................................................................ 22
Append WSDLs ................................................................................................................ 22
HCSCreditScoreLookupWcf.svc .................................................................................. 22
HcsCreditScoreLookupWcf.wsdl HCSLookup.wsdl ..................................................... 22
HCSCreditScoreWcf.svc .............................................................................................. 22
~ 4 ~
INTRODUCTION
Human Capital Score™ Web Service
People Capital’s Human Capital Score™ provides powerful new insights to Student Loan
analysis by evaluating a student’s academic attributes to determine their ability to earn
income and the capacity to repay a loan.
People Capital’s Human Capital Score™ Web Service allows you to seamlessly interface
with People Capital’s Human Capital Score™ calculator and integrate the output into
your existing systems and end-user desktop applications.
Output from People Capital’s Human Capital Score™ calculator is now available for
real-time redistribution into your own customized applications. Using your interface to
access Human Capital Score™ output means you have greater control, superior flexibility
and a more effective working environment.
People Capital’s Human Capital Score™ output provides:
Future income projections for the 10 years post graduation: This allows the
classification of students into various risk categories which lenders can use to
consider the capacity of a given group of college students to repay loans of long-
and short maturities. The projected income shortly after graduation is a good
indicator of short term capacity to pay. Longer-term loans can be assessed by
looking at predicted income over a longer period. For benchmarking purposes, we
provide a Human Capital Score™ for students for the period 2 years and 8 years
post-graduation.
Ranges of the income predictions: The Human Capital Score™ offers broad
ranking categories as well as measures of ranges of possible income paths. This
makes it possible to evaluate the likelihood that income will fall below a certain
threshold in a given year, or that average income will fall below a certain
threshold in the 10 years following graduation.
Scores tailored to specific circumstances: Not all loans are the same. There is a
world of difference for a medical student between having to repay a short-term
loan within a few years of graduating from his or her undergraduate institution,
and having to repay a loan that has deferred payments not coming due until 10
years later. The Human Capital Score™ takes into consideration debt-to-income
ratios to better inform your loan analysis.
Key Benefits to the User Human Capital Score™ integrated into your own applications.
~ 5 ~
Real-time delivery to your desktop
Accessible anywhere with an internet connection
Data can be stored locally, increasing client access speed
Key Benefits to the Company Seamless integration into your existing systems and desktop applications
Quick and easy to set up
Highly flexible tool
Allows clients to customize their own sites at enterprise level through to end user
level
Deploy and manage information more effectively
~ 6 ~
SUMMARY This document will outline the interaction to the Human Capital Score Web
Service interface. In order to utilize this interface you will need the following keys:
1) Company ID, which will be in the form of a GUID
2) Certificate from People Capital’s Certificate Authority
In order to get these pieces of information, please contact People Capital.
CONNECTION URLs:
https://www.humancapitalscore.com/HCS/HcsCreditScore.svc
https://www.humancapitalscore.com/HCS/HcsLookup.svc
~ 7 ~
SERVICES Two entry points are provided to gain access to this service. The first,
“HCSCreditScoreLookupWcf”, provides access to all the lookup values that will be
consumed for the call to the calculator. While this service can be utilized to populate
your input forms directly, our suggestion would be to cache this data. The data for a
given version will not change once it is posted on the web site. And new versions will not
be posted more than once a day.
The second entry point is for the main calculator “HCSCreditScoreWcf”. This
service will take your company’s unique identification GUID and the rest of the input
parameters.
Below is a high level outline of the service contracts, however please see the
appendix or embedded WSDL for the details.
HCSCreditScoreLookupWcf.svc Service Contract Operation Summary
HcsCreditScoreLookup GetCurrentVersion Will return the most current version of
the inputs for your company
HcsCreditScoreLookup GetSchoolInfo Will return all school info for the given
version number
HcsCreditScoreLookup GetTestInfo Will return all tests for the given
version number
HcsCreditScoreLookup GetAddressTypeInf
o
Will return all address types for the
given version number
HcsCreditScoreLookup GetDegreeInfo Will return all degrees for the given
version number
HcsCreditScoreLookup SchoolLevelInfo Will return all school levels for the
given version number
HcsCreditScoreLookup GetFieldOfStudyInf
o
Will return all field of studies for the
given version number
HcsCreditScoreLookup GetSchoolDegree Will return all joining for the school
and degree combination for the given
version number. Currently not used for
the calculator
HCSCreditScoreWcf.svc Service Contract Operation Summary
HcsCreditScore CalculateScore This operation will accept all the necessary
inputs to start the calculation of the HCS
credit scores as well as your company’s
unique id. The return will be a GUID that
will be your record identifier for the
GetCreditScoreResult Operation.
HcsCreditScore GetCreditScoreResult This operation will accept your company’s
unique id as well as the record identifier.
~ 8 ~
The results will be returned in two
collections*. These collections will contain
the future income projections and
HCSScore. The results will be stored for 7
days. Collections will be limited based on the level of service for your company
~ 9 ~
APPENDIX
Services
HcsCreditScoreLookupWcf Service Contracts
o HcsCreditScoreLookup
Address
o https://www.humancapitalscore.com/HCS/HcsLookup.svc
HcsCreditScoreWcf Service Contracts
o HcsCreditScore
Address
https://www.humancapitalscore.com/HCS/HcsCreditScore.svc
~ 10 ~
Service Contracts
HcsCreditScore Service: HcsCreditScoreWcf
Operations:
o CalculateScore
o GetCreditScoreResults
HcsCreditScoreLookup Service: HcsCreditScoreLookupWcf
Operations:
o GetCurrentVersion
o GetSchoolInfo
o GetTestInfo
o GetAddressTypeInfo
o GetDegreeInfo
o GetSchoolLevelInfo
o GetFieldOfStudyInfo
o GetSchoolDegreeInfo
~ 11 ~
Operations
CalculateScore Service Contract
o HcsCreditScore
Messages
o Inbound
CalculateScoreMsgRequest
o Outbound
CalculateScoreMsgResult
Faults
o GeneralFault - GeneralFaultDC
GetCreditScoreResults Service Contract
o HcsCreditScore
Messages
o Inbound
GetCreditScoreResultsMsgRequest
o Outbound
GetCreditScoreResultsMsgResult
Faults
o GeneralFault – GeneralFaultDC
o ProcessingFault – CreditScoreResultFault
o ValidationFault - CalcValidationError
GetCurrentVersion Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetCurrentVersionMsgRequest
o Outbound
GetCurrentVersionMsgResult
Faults
o GeneralFault - GeneralFaultDC
GetSchoolInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetSchoolInfoMsgRequest
o Outbound
GetSchoolInfoMsgResult
Faults
o GeneralFault - GeneralFaultDC
~ 12 ~
GetTestInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetTestsInfoMsgRequest
o Outbound
GetTestsInfoMsgResult
Faults
o GeneralFault - GeneralFaultDC
GetAddressTypeInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetAddressTypeMsgRequest
o Outbound
GetAddressTypeMsgResult
Faults
o GeneralFault - GeneralFaultDC
GetDegreeInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetDegreeMsgRequest
o Outbound
GetDegreeMsgResponse
Faults
o GeneralFault - GeneralFaultDC
GetSchoolLevelInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetSchoolLevelMsgRequest
o Outbound
GetSchoolLevelMsgResponse
Faults
o GeneralFault - GeneralFaultDC
GetFieldOfStudyInfo Service Contract
o HcsCreditScoreLookup
Messages
~ 13 ~
o Inbound
GetFieldOfStudyMsgRequest
o Outbound
GetFieldOfStudyResponse
Faults
o GeneralFault - GeneralFaultDC
GetSchoolDegreeInfo Service Contract
o HcsCreditScoreLookup
Messages
o Inbound
GetSchoolDegreeMsgRequest
o Outbound
GetSchoolDegreeMsgRespones Faults
o GeneralFault - GeneralFaultDC
Messages
CalculateScoreMsgRequest Operation
o CalculateScore
Parts
o FinancialInstituteId – GUID
Unique ID provided by People Capital
o CreditScoreRequest - DataContract
CalculateScoreMsgResult Operation
o CalculateScore
Parts
o CreditScoreId – GUID
Unique ID provided by the submission of a calculation request
GetCreditScoreResultsMsgRequest Operation
o GetCreditScoreResults
Parts
o FinancialInstituteId – GUID
Unique ID provided by People Capital
o CreditScoreId – GUID
Unique ID provided by the submission of a calculation request
GetCreditScoreResultsMsgResult Operation
o GetCreditScoreResults
Parts
o CreditScoreResult - DataContract
~ 14 ~
GetCurrentVersionMsgRequest Operation
o GetCurrentVersion
Parts
o FinancialInstituteId – GUID
Unique ID provided by People Capital
GetCurrentVersionMsgResult Operation
o GetCurrentVersion
Parts
o CurrentVersion – Int32
The current version of parameter lookup fields. If this number
changes, please grab all new values
GetSchoolInfoMsgRequest Operation
o GetSchoolInfo
Parts
o GetInfo – DataContract
GetSchoolInfoMsgResult Operation
o GetSchoolInfo
Parts
o Schools – DataContract
GetTestsInfoMsgRequest Operation
o GetTestInfo
Parts
o GetInfo – DataContract
GetTestsInfoMsgResult Operation
o GetTestInfo
Parts
o Tests – DataContract
GetAddressTypeMsgRequest Operation
o GetAddressTypeInfo
Parts
o GetInfo – DataContract
GetAddressTypeMsgResult Operation
o GetAddressTypeInfo
Parts
~ 15 ~
o AddressTypes – DataContract
GetDegreeMsgRequest Operation
o GetDegreeInfo
Parts
o GetInfo – DataContract
GetDegreeMsgResponse Operation
o GetDegreeInfo
Parts
o Degrees – DataContract
GetSchoolLevelMsgRequest Operation
o GetSchoolLevelInfo
Parts
o GetInfo – DataContract
GetSchoolLevelMsgResponse Operation
o GetSchoolLevelInfo
Parts
o SchoolLevels – DataContract
GetFieldOfStudyMsgRequest Operation
o GetFieldOfStudyInfo
Parts
o GetInfo – DataContract
GetFieldOfStudyResponse Operation
o GetFieldOfStudyInfo
Parts
o FieldOfStudys – DataContract
GetSchoolDegreeMsgRequest Operation
o GetSchoolDegreeInfo
Parts
o GetInfo – DataContract
GetSchoolDegreeMsgResponse Operation
o GetSchoolDegreeInfo
Parts
~ 16 ~
o SchoolDegrees – DataContract
~ 17 ~
Data Contract * - Indicates value from the lookup interface
DC – Indicates another Data Contract
CreditScoreRequest Members
o SchoolCollection - DC
o TestCollection - DC
o Version* – Int32
Version of lookup values in submission. Must be a valid value.
o PersonalAddressCollection - DC
o PersonalInfo - DC
PersonalAddressCollection Members
o PersonalAddress[] - DC
SchoolCollection Members
o School[] - DC
TestCollection Members
o Test[] - DC
PersonalInfo Members
o PersonalId – string
[WARNING]: Please DO NOT provide Social Security Numbers
for Unique Borrower IDs. If this is a current requirement for your
Unique Borrower IDs, please contact People Capital beforehand.
o BirthDate – DateTime
The birthdate of the person making the loan.
PersonalAddress Members
o PostalCode – String
Zip code for the address type entered. Validated against standard
US formats.
o AddressTypeId* – Int32
The id must come from the lookup provided the lookup service.
Test Members
o TestId * - Int32
The id must come from the lookup provided the lookup service
o Score – Int16
The score of the test. This will be validated against standard test
score ranges.
~ 18 ~
School Members
o SchoolId – Int32
The id must come from the lookup provided the lookup service
o FieldOfStudyCollection – DC
o GPA – Double
GPA of the student
o StatusId * - Int32
The id must come from the lookup provided the lookup service
o GradYear – Int32
o DegreeId * - Int32
The id must come from the lookup provided the lookup service
FieldOfStudyCollection Members
o FieldOfStudy[] - DC
FieldOfStudy Members
o DegreeId * - Int32
The id must come from the lookup provided the lookup service
o IsMajor – Boolean
o GPA - Double
CreditScoreResult Members
o IncomeProjectionCollection – DC
o HCSScoreCollection - DC
IncomeProjectionCollection Members
o IncomeProjection[] - DC
IncomeProjection Members
o YearsOut – Int32
o MiddleAmount – Decimal
o HighAmount – Decimal
o LowAmount - Decimal
HCSScoreCollection Members
o HCSScoreCollection - DC
HCSScore Members
o Score – decimal
o YearsOut – Int32
~ 19 ~
LookupGetInfo Members
o FinancialInstituteId – GUID
Unique ID provided by People Capital
o HCSVersionNumber – Int32
Lookup Value current version
LookupCurrentHCSVersion Members
o HCSVersionNumber – Int32
LookupTestCollection Members
o LookupTest[] – DC
LookupTest Members
o TestId – Int32
o TestName - string
LookupFieldOfStudyCollection Members
o LookupFieldOfStudy[] - DC
LookupFieldOfStudy Members
o FieldOfStudyId – Int32
o FiledName - string
LookupSchoolCollection Members
o LookupSchool[] - DC
LookupSchool Members
o SchoolId – Int32
o SchoolName – string
o SchoolLevelId* – Int32
o State - string
LookupSchoolDegreeCollection Members
o LookupSchoolDegree[] - DC
LookupSchoolDegree Members
o SchoolDegreeId – Int32
o DegreeId* – Int32
o SchoolId* – Int32
~ 20 ~
LookupAddressTypeCollection Members
o LookupAddressType[] - DC
LookupAddressType Members
o AddressTypeId – Int32
o AdressTypeName - string
LookupDegreeCollection Members
o LookupDegree[] - DC
LookupDegree Members
o DegreeId – Int32
o DegreeName - string
LookupSchoolLevelCollection Members
o LookupSchoolLevel[] - DC
LookupSchoolLevel
~ 21 ~
Members
o LevelId – Int32
o LevelName - string
~ 22 ~
FaultContracts
CalcValidationError Members
o ErrorId – Int32
o ErrorMessage – string
CreditScoreResultFault Members
o CalcUnderway – bool
o CalcInError – bool
o ErrorMessage – string
GeneralFaultDC Members
o ErrorId – int32
o Message - string
APPEND WSDLS
HCSCreditScoreLookupWcf.svc
HcsCreditScoreLookupWcf.wsdl HCSLookup.wsdl
HCSCreditScoreWcf.svc
HcsCreditScoreWcf.wsdl HcsCreditScore.wsdl
