Skip to content

one-on-one/cv_branding_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 

Repository files navigation

CV Branding

API (GET)

Parameters:

All query parameters typically passed to the call intake are expected for this API; most important are:

  • leadid
  • personal data (first_name, last_name, etc...)
  • school or program specific data (program of interest, current education level, etc...)

Example Requests: Base URI:

http://assure-quality.1on1.com/call_brand?

Base query params:

leadid=604783278282376&
program=BB&
[email protected]&
Street=58943627841%20LE%20XARX%20DR&
City=FLINSTONES&
State=DE&
Zip=19489327&
Home_Phone=3473982648937&
first_name=GRIFFLEMOMNGER&
last_name=TESTEHEAD&
desireddegree=N&
hsgrad=1988&
birthyear=1970&
currentedlevel=HighSchool&
desiredstart=0&
military=N&
campusinterest=N&
repcode=61dsiou906&
gender=M

Full Request (with all query params)

http://assure-quality.1on1.com/call_brand?leadid=162985476329496924&program=TSC&program_2=&vendorcode=OV.EDU_C.NICCV_S.GENX_R.INC_M.CI&[email protected]&[email protected]&Street=1509%20MORDOR%20ST&address_1=1509%20MORDOR%20ST&City=GRUMBLECAKES&State=UT&Zip=23222&Home_Phone=1234567891&Phone2=&Phone3=&first_name=GUBSUMPLER&last_name=SHRAMRAMPLE&originator_id=1689326543548329920&origin_tracking_code=&audit_id=DtreAA-0B5F-F5FreDFG-324C-4437fged824678&desireddegree=N&hsgrad=2009&birthyear=1990&gender=M&currentedlevel=HighSchool&desiredstart=0&military=N&edu_currently_enrolled_elsewhere=N&campusinterest=N&repcode=3333333&

Example Response: API return JSON responses:

{"response_total":3.263088,"multiplier":2,"contract":[32,1044]}

Reading through a JSON formatter:

{
  response_total: 3.263088,
  multiplier: 2,
  contract: [
    32,
    1044
  ]
}

Try Call Branding API

Testing and other options

The API allows rpobust testing on our part and for that I have created a number of API options to allow us to test both performance and quality. If these options are used One On One cannot support the use of the results as valid.

There are two tiers of testing. For basic API integration pass

  • no_prizm=true

If you need to test running Prizm results (i.e., ordering the list of valid branded contracts in terms of Priority), then pass

  • no_prospector=true

Other Information

MetaData fields

There are a number of data points collected to provide insight into how the API is performing, as well as providing robust feedback to users of the API and logging. Currenlty the only MetaData field provided for the user is response_total, which is measured in number of seconds for a full request. An example of the standared MetaData set that gets logged:

{
  "metadata": [
    {
      "request_url": "VCID-PRIZM-PROSPECTOR:: http://assure-quality.1on1.com/call_brand?....",
    "response_total": 2.085868,
    "response_qualify": "VCID-PRIZM-PROSPECTOR:: 1.098527"
    }
  ]
}

About

Documentation for CV Branding Public Facing API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published