YM REST Services

<back to all web services

Templates

Requires Authentication
Requires the role:member
The following routes are available for this service:
GET/Ymc/{ClientID}/Member/{MemberID}/TemplatesReturns the filter details needed to build the Advanced Search criteria and Job Alert criteria.
Templates Parameters:
NameParameterData TypeRequiredDescription
TemplateTypequeryTemplateTypeNo

Allowable Values

  • JobAlert
  • JobSearch
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
TemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateNameformstringNo
responseformData[]No
Data Parameters:
NameParameterData TypeRequiredDescription
typeformstringNo
idformintNo
generated_template_idformintNo
site_idformintNo
partner_idformintNo
questionsformQuestions[]No
Questions Parameters:
NameParameterData TypeRequiredDescription
generated_question_idformintNo
idformintNo
textformstringNo
presentation_textformstringNo
typeformstringNo
sizeformintNo
maxformintNo
requiredformboolNo
aliasformstringNo
output_availableformboolNo
datashareformintNo
groupformstringNo
ansshareformintNo
originalformintNo
template_idformintNo
actual_posformintNo
legacy_idformintNo
generated_template_idformintNo
answersformAnswers[]No
Answers Parameters:
NameParameterData TypeRequiredDescription
idformintNo
textformstringNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-03T01:23:02.0623009-04:00","Device":"Desktop"}