YM REST Services

<back to all web services

JobAlertsCriteria

Requires Authentication
Requires the role:member
The following routes are available for this service:
GET/Ymc/{ClientID}/Member/{MemberID}/JobAlertsCriteriaReturns the selection criteria that has been saved under a given alert ID.
JobAlertsCriteria Parameters:
NameParameterData TypeRequiredDescription
JobAlertIdqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
JobAlertsCriteriaResponse Parameters:
NameParameterData TypeRequiredDescription
responseformDataNo
Data Parameters:
NameParameterData TypeRequiredDescription
idformintNo
nameformstringNo
addedformDateTimeNo
expireformDateTimeNo
expires_informExpiresInNo
send_frequencyformintNo
activeformboolNo
filtersformList<Questions>No
ExpiresIn Parameters:
NameParameterData TypeRequiredDescription
valueformintNo
unitformDateUnitNo
Questions Parameters:
NameParameterData TypeRequiredDescription
idformintNo
keyformstringNo
answersformAnswers[]No
Answers Parameters:
NameParameterData TypeRequiredDescription
idformintNo
textformstringNo

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.

GET /Ymc/{ClientID}/Member/{MemberID}/JobAlertsCriteria HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	response: 
	{
		id: 0,
		name: String,
		added: 0001-01-01,
		expire: 0001-01-01,
		expires_in: 
		{
			value: 0,
			unit: d
		},
		send_frequency: 0,
		active: False,
		filters: 
		[
			{
				id: 0,
				key: String,
				answers: 
				[
					{
						id: 0,
						text: String
					}
				]
			}
		]
	},
	JobAlertId: 0,
	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-03T00:38:07.4479151-04:00,
	Device: Desktop
}