C# Class CBApi.CbApi

Inheritance: ICBApi

Show file Open project: usbsnowcrash/Careerbuilder.Net Class Usage Examples

Protected Properties

Property	Type	Description
_AfterListeners	List
_BeforeListeners	List
_Settings	CBApi.APISettings

Public Methods

Method	Description
AnonymousApplication ( AnonymousApplicationRequest request ) : AnonymousApplicationResponse	Anonymous apply with /v2/Application/submit
ApplyLink ( ApplyLink request ) : string	Gets the ApplyLink for a Job
ApplyLink ( NameValueCollection request ) : string	Gets the ApplyLink for a Job
CreateSavedSearch ( SavedSearchCreate app ) : CBApi.Models.SavedSearchCreateResponse
DeleteSavedSearchXML ( RequestSavedSearchDelete search ) : SavedSearchDeleteResponse
GetAccessToken ( string clientId, string clientSecret, string code, string redirectUri ) : AccessToken	Make a call to /auth/token
GetApplicationForm ( string jobDid ) : string	Make a call to /v1/application/form
GetBlankApplication ( string jobDid ) : BlankApplication	Make a call to /v1/application/blank
GetCategories ( ) : ICategoryRequest	Make a call to /v1/categories
GetEducationCodes ( ) : IEducationCodesRequest	Make a call to /v1/educationcodes
GetEmployeeTypes ( ) : IEmployeeTypesRequest	Make a call to /v1/employeetypes
GetJob ( string jobDid ) : CBApi.Models.Job	Make a call to /v1/job
GetOAuthRedirectUri ( string clientId, string redirectUri, string permissions ) : Uri	Gets the Uri to redirect to for OAuth
GetRecommendationsForJob ( string jobDid ) : List	Make a call to /v1/recommendations/forjob
GetRecommendationsForJobWithUserPreferences ( string jobDid, string userDid ) : List	Make a call to /v1/recommendations/forjobwithuserprefs
GetRecommendationsForUser ( string externalId ) : List	make a call to /v1/recommendations/foruser
JobReport ( string jobDid ) : CBApi.Models.Responses.ResponseJobReport
JobSearch ( ) : IJobSearch	Make a call to /v1/jobsearch
ListSavedSearches ( SavedSearchListRequestModel app ) : CBApi.Models.SavedSearchListResponseModel	Lists all saved searches from a single user
RetrieveASavedSearch ( string savedSearchDID, string userOAuthToken ) : Models.WebAPIs.SavedSearch.SavedSearches
RetrieveSavedSearch ( SavedSearchRetrieveRequestModel app ) : SavedSearchRetrieveResponseModel	Retrieve a single saved search
SubmitApplication ( CBApi.Models.Application app ) : ResponseApplication	Submit an application to /v1/application/submit
SubmitApplication ( RequestApplication app ) : ResponseApplication	Submit an application to /v1/application/submit
UpdateSavedSearch ( SavedSearchUpdateRequestModel app ) : SavedSearchUpdateResponseModel	Updates a SavedSearch

Protected Methods

Method	Description
CbApi ( ) : System.Collections.Generic
CbApi ( string key ) : System.Collections.Generic
CbApi ( string key, int timeout ) : System.Collections.Generic
CbApi ( string key, int timeout, TargetSite site ) : System.Collections.Generic
CbApi ( string key, string cobrandCode ) : System.Collections.Generic
CbApi ( string key, string cobrandCode, string siteid ) : System.Collections.Generic
WireAfterRequestEvents ( BaseRequest req ) : void
WireBeforeRequestEvents ( BaseRequest req ) : void

Method Details

AnonymousApplication() public method

Anonymous apply with /v2/Application/submit

public AnonymousApplication ( AnonymousApplicationRequest request ) : AnonymousApplicationResponse
request	CBApi.Models.AnonymousApplicationRequest	the input for the application
return	CBApi.Models.AnonymousApplicationResponse

ApplyLink() public method

Gets the ApplyLink for a Job

public ApplyLink ( ApplyLink request ) : string
request	ApplyLink	An ApplyLink values collection to pass to the api.
return	string

ApplyLink() public method

Gets the ApplyLink for a Job

public ApplyLink ( NameValueCollection request ) : string
request	NameValueCollection	A named value collection of params to pass to the api
return	string

CbApi() protected method

protected CbApi ( ) : System.Collections.Generic
return	System.Collections.Generic

CbApi() protected method

protected CbApi ( string key ) : System.Collections.Generic
key	string
return	System.Collections.Generic

CbApi() protected method

protected CbApi ( string key, int timeout ) : System.Collections.Generic
key	string
timeout	int
return	System.Collections.Generic

CbApi() protected method

protected CbApi ( string key, int timeout, TargetSite site ) : System.Collections.Generic
key	string
timeout	int
site	CBApi.Models.Service.TargetSite
return	System.Collections.Generic

CbApi() protected method

protected CbApi ( string key, string cobrandCode ) : System.Collections.Generic
key	string
cobrandCode	string
return	System.Collections.Generic

CbApi() protected method

protected CbApi ( string key, string cobrandCode, string siteid ) : System.Collections.Generic
key	string
cobrandCode	string
siteid	string
return	System.Collections.Generic

CreateSavedSearch() public method

public CreateSavedSearch ( SavedSearchCreate app ) : CBApi.Models.SavedSearchCreateResponse
app	CBApi.Models.SavedSearchCreate	the saved search that is wanting to be saved
return	CBApi.Models.SavedSearchCreateResponse

DeleteSavedSearchXML() public method

public DeleteSavedSearchXML ( RequestSavedSearchDelete search ) : SavedSearchDeleteResponse
search	RequestSavedSearchDelete	The search being deleted
return	CBApi.Models.SavedSearchDeleteResponse

GetAccessToken() public method

Make a call to /auth/token

public GetAccessToken ( string clientId, string clientSecret, string code, string redirectUri ) : AccessToken
clientId	string	20 character long external client ID.
clientSecret	string	64 character long external client secret.
code	string	20 character long OAuth authorization grant code returned from auth/prompt redirection.
redirectUri	string	URL that was provided at the time of external client registration.
return	CBApi.Models.AccessToken

GetApplicationForm() public method

Make a call to /v1/application/form

public GetApplicationForm ( string jobDid ) : string
jobDid	string
return	string

GetBlankApplication() public method

Make a call to /v1/application/blank

public GetBlankApplication ( string jobDid ) : BlankApplication
jobDid	string
return	CBApi.Models.BlankApplication

GetCategories() public method

Make a call to /v1/categories

public GetCategories ( ) : ICategoryRequest
return	ICategoryRequest

GetEducationCodes() public method

Make a call to /v1/educationcodes

public GetEducationCodes ( ) : IEducationCodesRequest
return	IEducationCodesRequest

GetEmployeeTypes() public method

Make a call to /v1/employeetypes

public GetEmployeeTypes ( ) : IEmployeeTypesRequest
return	IEmployeeTypesRequest

GetJob() public method

Make a call to /v1/job

public GetJob ( string jobDid ) : CBApi.Models.Job
jobDid	string
return	CBApi.Models.Job

GetOAuthRedirectUri() public method

Gets the Uri to redirect to for OAuth

public GetOAuthRedirectUri ( string clientId, string redirectUri, string permissions ) : Uri
clientId	string
redirectUri	string
permissions	string
return	System.Uri

GetRecommendationsForJob() public method

Make a call to /v1/recommendations/forjob

public GetRecommendationsForJob ( string jobDid ) : List
jobDid	string
return	List

GetRecommendationsForJobWithUserPreferences() public method

Make a call to /v1/recommendations/forjobwithuserprefs

public GetRecommendationsForJobWithUserPreferences ( string jobDid, string userDid ) : List
jobDid	string
userDid	string	The unique ID of the user
return	List

GetRecommendationsForUser() public method

make a call to /v1/recommendations/foruser

public GetRecommendationsForUser ( string externalId ) : List
externalId	string	The ID of the user that you wish to get recs for
return	List

JobReport() public method

public JobReport ( string jobDid ) : CBApi.Models.Responses.ResponseJobReport
jobDid	string
return	CBApi.Models.Responses.ResponseJobReport

JobSearch() public method

Make a call to /v1/jobsearch

public JobSearch ( ) : IJobSearch
return	IJobSearch

ListSavedSearches() public method

Lists all saved searches from a single user

public ListSavedSearches ( SavedSearchListRequestModel app ) : CBApi.Models.SavedSearchListResponseModel
app	CBApi.Models.SavedSearchListRequestModel	info to lead to the users saved searches
return	CBApi.Models.SavedSearchListResponseModel

RetrieveASavedSearch() public method

public RetrieveASavedSearch ( string savedSearchDID, string userOAuthToken ) : Models.WebAPIs.SavedSearch.SavedSearches
savedSearchDID	string
userOAuthToken	string
return	Models.WebAPIs.SavedSearch.SavedSearches

RetrieveSavedSearch() public method

Retrieve a single saved search

public RetrieveSavedSearch ( SavedSearchRetrieveRequestModel app ) : SavedSearchRetrieveResponseModel
app	CBApi.Models.SavedSearchRetrieveRequestModel	Info to lead to the saved search
return	SavedSearchRetrieveResponseModel

SubmitApplication() public method

Submit an application to /v1/application/submit

public SubmitApplication ( CBApi.Models.Application app ) : ResponseApplication
app	CBApi.Models.Application	The application being submited to careerbuilder
return	CBApi.Models.ResponseApplication

SubmitApplication() public method

Submit an application to /v1/application/submit

public SubmitApplication ( RequestApplication app ) : ResponseApplication
app	CBApi.Models.RequestApplication	The application being submited to careerbuilder
return	CBApi.Models.ResponseApplication

UpdateSavedSearch() public method

Updates a SavedSearch

public UpdateSavedSearch ( SavedSearchUpdateRequestModel app ) : SavedSearchUpdateResponseModel
app	CBApi.Models.SavedSearchUpdateRequestModel	The data for the savedsearch
return	SavedSearchUpdateResponseModel

WireAfterRequestEvents() protected method

protected WireAfterRequestEvents ( BaseRequest req ) : void
req	CBApi.Framework.Requests.BaseRequest
return	void

WireBeforeRequestEvents() protected method

protected WireBeforeRequestEvents ( BaseRequest req ) : void
req	CBApi.Framework.Requests.BaseRequest
return	void

Property Details

_AfterListeners protected property

protected List _AfterListeners
return	List

_BeforeListeners protected property

protected List _BeforeListeners
return	List

_Settings protected property

protected APISettings,CBApi _Settings
return	CBApi.APISettings