YM REST Services

Templates

**Requires Authentication**
Requires the role:	member

The following routes are available for this service:
GET	/Ymc/{ClientID}/Member/{MemberID}/Templates	Returns the filter details needed to build the Advanced Search criteria and Job Alert criteria.

**Templates** Parameters:
Name	Parameter	Data Type	Required	Description
TemplateType	query	TemplateType	No	Allowable Values JobAlert JobSearch

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**TemplatesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
TemplateName	form	string	No
response	form	Data[]	No

**Data** Parameters:
Name	Parameter	Data Type	Required
type	form	string	No
id	form	int	No
generated_template_id	form	int	No
site_id	form	int	No
partner_id	form	int	No
questions	form	Questions[]	No

**Questions** Parameters:
Name	Parameter	Data Type	Required
generated_question_id	form	int	No
id	form	int	No
text	form	string	No
presentation_text	form	string	No
type	form	string	No
size	form	int	No
max	form	int	No
required	form	bool	No
alias	form	string	No
output_available	form	bool	No
datashare	form	int	No
group	form	string	No
ansshare	form	int	No
original	form	int	No
template_id	form	int	No
actual_pos	form	int	No
legacy_id	form	int	No
generated_template_id	form	int	No
answers	form	Answers[]	No

**Answers** Parameters:
Name	Parameter	Data Type	Required	Description
id	form	int	No
text	form	string	No

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}/Templates HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TemplateName: String,
	response: 
	[
		{
			type: String,
			id: 0,
			generated_template_id: 0,
			site_id: 0,
			partner_id: 0,
			questions: 
			[
				{
					generated_question_id: 0,
					id: 0,
					text: String,
					presentation_text: String,
					type: String,
					size: 0,
					max: 0,
					required: False,
					alias: String,
					output_available: False,
					datashare: 0,
					group: String,
					ansshare: 0,
					original: 0,
					template_id: 0,
					actual_pos: 0,
					legacy_id: 0,
					generated_template_id: 0,
					answers: 
					[
						{
							id: 0,
							text: String
						}
					]
				}
			]
		}
	],
	TemplateType: JobAlert,
	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-03T06:23:19.8331836-04:00,
	Device: Desktop
}

YM REST Services

Templates

Allowable Values

HTTP + JSV