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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <TemplateType>JobAlert</TemplateType>
  <TemplateName>String</TemplateName>
  <response>
    <TemplatesApiResponse.Data>
      <generated_template_id>0</generated_template_id>
      <id>0</id>
      <partner_id>0</partner_id>
      <questions>
        <TemplatesApiResponse.Data.Questions>
          <actual_pos>0</actual_pos>
          <alias>String</alias>
          <ansshare>0</ansshare>
          <answers>
            <TemplatesApiResponse.Data.Questions.Answers>
              <id>0</id>
              <text>String</text>
            </TemplatesApiResponse.Data.Questions.Answers>
          </answers>
          <datashare>0</datashare>
          <generated_question_id>0</generated_question_id>
          <generated_template_id>0</generated_template_id>
          <group>String</group>
          <id>0</id>
          <legacy_id>0</legacy_id>
          <max>0</max>
          <original>0</original>
          <output_available>false</output_available>
          <presentation_text>String</presentation_text>
          <required>false</required>
          <size>0</size>
          <template_id>0</template_id>
          <text>String</text>
          <type>String</type>
        </TemplatesApiResponse.Data.Questions>
      </questions>
      <site_id>0</site_id>
      <type>String</type>
    </TemplatesApiResponse.Data>
  </response>
</TemplatesResponse>