YM REST Services

<back to all web services

JobAlerts

Requires Authentication
Requires the role:member
The following routes are available for this service:
GET/Ymc/{ClientID}/Member/{MemberID}/JobAlertsReturns a list of jobs from the job alert.
POST/Ymc/{ClientID}/Member/{MemberID}/JobAlertsCreate a new job alert
PUT/Ymc/{ClientID}/Member/{MemberID}/JobAlertsUpdate an existing job alert
DELETE/Ymc/{ClientID}/Member/{MemberID}/JobAlertsDelete a job alert
JobAlerts Parameters:
NameParameterData TypeRequiredDescription
JobAlertIdbodyintNo
NamebodystringNo
FrequencybodyintNo
expires_inbodyExpiresInNo
startbodyintNo
rowsbodyintNo
sortbodystringNo
ActivebodyboolNo
FilterbodyDictionary<string, List<Selection>>No
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ExpiresIn Parameters:
NameParameterData TypeRequiredDescription
valueformintNo
unitformDateUnitNo
JobAlertsResponse Parameters:
NameParameterData TypeRequiredDescription
responseformData[]No
Data Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
nameformstringNo
expires_informExpiresInNo
send_frequencyformintNo
ActiveformboolNo
filtersformList<Questions>No
jobsformJobsNo
Questions Parameters:
NameParameterData TypeRequiredDescription
idformintNo
keyformstringNo
answersformAnswers[]No
Answers Parameters:
NameParameterData TypeRequiredDescription
idformintNo
textformstringNo
Jobs Parameters:
NameParameterData TypeRequiredDescription
num_foundformintNo
startformintNo
rowsformintNo
sortformstringNo
docsformDoc[]No
Doc Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
sitejobidformstringNo
positionformstringNo
site_idformstringNo
cityformstring[]No
countryformstring[]No
industryformstring[]No
locationformstring[]No
regionformstring[]No
stateformstring[]No
zipformstring[]No
companyformstringNo
durationformstringNo
educationformstringNo
entrylevelformboolNo
experienceformstringNo
functionformstring[]No
sortformlongNo
contact_emailformstringNo
contact_phoneformstringNo
contact_nameformstringNo
jobpoolformboolNo
anonymousformboolNo
state_abbrformstring[]No
country_abbrformstring[]No
internshipformboolNo
job_categoryformstringNo
rankformstringNo
powerpostformboolNo
spotlightformboolNo
origin_site_idformstringNo
job_typeformstringNo
recruiter_idformstringNo
salaryformstringNo
salary_currencyformstringNo
salary_highformstringNo
salary_lowformstringNo
salary_typeformstringNo
securityformstringNo
travelformstringNo
careerfairformstringNo
descriptionformstringNo
latlonformstringNo
latitudeformstringNo
longitudeformstringNo
network_verticalformstringNo
requirementsformstringNo
sourceformstringNo
source_idformstringNo
apply_onlineformboolNo
apply_urlformstringNo
job_urlformstringNo
languageformstringNo
posted_dateformDateTimeNo
expire_dateformDateTimeNo
start_dateformDateTimeNo
updatedformDateTimeNo
featuredformboolNo
preferredformboolNo
veteransupgradeformintNo
diversityupgradeformintNo
socialupgradeformintNo
linkformstringNo
is_savedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ymc/{ClientID}/Member/{MemberID}/JobAlerts HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	JobAlertId: 0,
	Name: String,
	Frequency: 0,
	expires_in: 
	{
		value: 0,
		unit: d
	},
	start: 0,
	rows: 0,
	sort: String,
	Active: False,
	Filter: 
	{
		String: 
		[
			{
				Id: 0,
				Text: String
			}
		]
	},
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T01:41:22.2032064-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	response: 
	[
		{
			id: String,
			name: String,
			expires_in: 
			{
				value: 0,
				unit: d
			},
			send_frequency: 0,
			Active: False,
			filters: 
			[
				{
					id: 0,
					key: String,
					answers: 
					[
						{
							id: 0,
							text: String
						}
					]
				}
			],
			jobs: 
			{
				num_found: 0,
				start: 0,
				rows: 0,
				sort: String,
				docs: 
				[
					{
						id: String,
						sitejobid: String,
						position: String,
						site_id: String,
						city: 
						[
							String
						],
						country: 
						[
							String
						],
						industry: 
						[
							String
						],
						location: 
						[
							String
						],
						region: 
						[
							String
						],
						state: 
						[
							String
						],
						zip: 
						[
							String
						],
						company: String,
						duration: String,
						education: String,
						entrylevel: False,
						experience: String,
						function: 
						[
							String
						],
						sort: 0,
						contact_email: String,
						contact_phone: String,
						contact_name: String,
						jobpool: False,
						anonymous: False,
						state_abbr: 
						[
							String
						],
						country_abbr: 
						[
							String
						],
						internship: False,
						job_category: String,
						rank: String,
						powerpost: False,
						spotlight: False,
						origin_site_id: String,
						job_type: String,
						recruiter_id: String,
						salary: String,
						salary_currency: String,
						salary_high: String,
						salary_low: String,
						salary_type: String,
						security: String,
						travel: String,
						careerfair: String,
						description: String,
						latlon: String,
						latitude: String,
						longitude: String,
						network_vertical: String,
						requirements: String,
						source: String,
						source_id: String,
						apply_online: False,
						apply_url: String,
						job_url: String,
						language: String,
						posted_date: 0001-01-01,
						expire_date: 0001-01-01,
						start_date: 0001-01-01,
						updated: 0001-01-01,
						featured: False,
						preferred: False,
						veteransupgrade: 0,
						diversityupgrade: 0,
						socialupgrade: 0,
						link: String,
						is_saved: False
					}
				]
			}
		}
	],
	JobAlertId: 0,
	Name: String,
	Frequency: 0,
	expires_in: 
	{
		value: 0,
		unit: d
	},
	start: 0,
	rows: 0,
	sort: String,
	Active: False,
	Filter: 
	{
		String: 
		[
			{
				Id: 0,
				Text: String
			}
		]
	},
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T01:41:22.2188303-04:00,
	Device: Desktop
}