YM REST Services

JobAlerts

**Requires Authentication**
Requires the role:	member

The following routes are available for this service:
GET	/Ymc/{ClientID}/Member/{MemberID}/JobAlerts	Returns a list of jobs from the job alert.
POST	/Ymc/{ClientID}/Member/{MemberID}/JobAlerts	Create a new job alert
PUT	/Ymc/{ClientID}/Member/{MemberID}/JobAlerts	Update an existing job alert
DELETE	/Ymc/{ClientID}/Member/{MemberID}/JobAlerts	Delete a job alert

**JobAlerts** Parameters:
Name	Parameter	Data Type	Required
JobAlertId	body	int	No
Name	body	string	No
Frequency	body	int	No
expires_in	body	ExpiresIn	No
start	body	int	No
rows	body	int	No
sort	body	string	No
Active	body	bool	No
Filter	body	Dictionary<string, List<Selection>>	No

**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

**ExpiresIn** Parameters:
Name	Parameter	Data Type	Required	Description
value	form	int	No
unit	form	DateUnit	No

**JobAlertsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
response	form	Data[]	No

**Data** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
name	form	string	No
expires_in	form	ExpiresIn	No
send_frequency	form	int	No
Active	form	bool	No
filters	form	List<Questions>	No
jobs	form	Jobs	No

**Questions** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
key	form	string	No
answers	form	Answers[]	No

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

**Jobs** Parameters:
Name	Parameter	Data Type	Required
num_found	form	int	No
start	form	int	No
rows	form	int	No
sort	form	string	No
docs	form	Doc[]	No

**Doc** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
sitejobid	form	string	No
position	form	string	No
site_id	form	string	No
city	form	string[]	No
country	form	string[]	No
industry	form	string[]	No
location	form	string[]	No
region	form	string[]	No
state	form	string[]	No
zip	form	string[]	No
company	form	string	No
duration	form	string	No
education	form	string	No
entrylevel	form	bool	No
experience	form	string	No
function	form	string[]	No
sort	form	long	No
contact_email	form	string	No
contact_phone	form	string	No
contact_name	form	string	No
jobpool	form	bool	No
anonymous	form	bool	No
state_abbr	form	string[]	No
country_abbr	form	string[]	No
internship	form	bool	No
job_category	form	string	No
rank	form	string	No
powerpost	form	bool	No
spotlight	form	bool	No
origin_site_id	form	string	No
job_type	form	string	No
recruiter_id	form	string	No
salary	form	string	No
salary_currency	form	string	No
salary_high	form	string	No
salary_low	form	string	No
salary_type	form	string	No
security	form	string	No
travel	form	string	No
careerfair	form	string	No
description	form	string	No
latlon	form	string	No
latitude	form	string	No
longitude	form	string	No
network_vertical	form	string	No
requirements	form	string	No
source	form	string	No
source_id	form	string	No
apply_online	form	bool	No
apply_url	form	string	No
job_url	form	string	No
language	form	string	No
posted_date	form	DateTime	No
expire_date	form	DateTime	No
start_date	form	DateTime	No
updated	form	DateTime	No
featured	form	bool	No
preferred	form	bool	No
veteransupgrade	form	int	No
diversityupgrade	form	int	No
socialupgrade	form	int	No
link	form	string	No
is_saved	form	bool	No

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.

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

<JobAlerts 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>
  <Active>false</Active>
  <Filter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfSelectionTQsNWqW7>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Selection>
          <Id>0</Id>
          <Text>String</Text>
        </Selection>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfSelectionTQsNWqW7>
  </Filter>
  <Frequency>0</Frequency>
  <JobAlertId>0</JobAlertId>
  <Name>String</Name>
  <expires_in>
    <unit>d</unit>
    <value>0</value>
  </expires_in>
  <rows>0</rows>
  <sort>String</sort>
  <start>0</start>
</JobAlerts>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobAlertsResponse 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>
  <Active>false</Active>
  <Filter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfSelectionTQsNWqW7>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Selection>
          <Id>0</Id>
          <Text>String</Text>
        </Selection>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfSelectionTQsNWqW7>
  </Filter>
  <Frequency>0</Frequency>
  <JobAlertId>0</JobAlertId>
  <Name>String</Name>
  <expires_in>
    <unit>d</unit>
    <value>0</value>
  </expires_in>
  <rows>0</rows>
  <sort>String</sort>
  <start>0</start>
  <response>
    <JobAlertsApiResponse.Data>
      <Active>false</Active>
      <expires_in>
        <unit>d</unit>
        <value>0</value>
      </expires_in>
      <filters>
        <JobAlertsApiResponse.Data.Questions>
          <answers>
            <JobAlertsApiResponse.Data.Answers>
              <id>0</id>
              <text>String</text>
            </JobAlertsApiResponse.Data.Answers>
          </answers>
          <id>0</id>
          <key>String</key>
        </JobAlertsApiResponse.Data.Questions>
      </filters>
      <id>String</id>
      <jobs>
        <docs>
          <CareersBaseResponse.Doc>
            <anonymous>false</anonymous>
            <apply_online>false</apply_online>
            <apply_url>String</apply_url>
            <careerfair>String</careerfair>
            <city xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </city>
            <company>String</company>
            <contact_email>String</contact_email>
            <contact_name>String</contact_name>
            <contact_phone>String</contact_phone>
            <country xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </country>
            <country_abbr xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </country_abbr>
            <description>String</description>
            <diversityupgrade>0</diversityupgrade>
            <duration>String</duration>
            <education>String</education>
            <entrylevel>false</entrylevel>
            <experience>String</experience>
            <expire_date>0001-01-01T00:00:00</expire_date>
            <featured>false</featured>
            <function xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </function>
            <id>String</id>
            <industry xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </industry>
            <internship>false</internship>
            <is_saved>false</is_saved>
            <job_category>String</job_category>
            <job_type>String</job_type>
            <job_url>String</job_url>
            <jobpool>false</jobpool>
            <language>String</language>
            <latitude>String</latitude>
            <latlon>String</latlon>
            <link>String</link>
            <location xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </location>
            <longitude>String</longitude>
            <network_vertical>String</network_vertical>
            <origin_site_id>String</origin_site_id>
            <position>String</position>
            <posted_date>0001-01-01T00:00:00</posted_date>
            <powerpost>false</powerpost>
            <preferred>false</preferred>
            <rank>String</rank>
            <recruiter_id>String</recruiter_id>
            <region xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </region>
            <requirements>String</requirements>
            <salary>String</salary>
            <salary_currency>String</salary_currency>
            <salary_high>String</salary_high>
            <salary_low>String</salary_low>
            <salary_type>String</salary_type>
            <security>String</security>
            <site_id>String</site_id>
            <sitejobid>String</sitejobid>
            <socialupgrade>0</socialupgrade>
            <sort>0</sort>
            <source>String</source>
            <source_id>String</source_id>
            <spotlight>false</spotlight>
            <start_date>0001-01-01T00:00:00</start_date>
            <state xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </state>
            <state_abbr xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </state_abbr>
            <travel>String</travel>
            <updated>0001-01-01T00:00:00</updated>
            <veteransupgrade>0</veteransupgrade>
            <zip xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </zip>
          </CareersBaseResponse.Doc>
        </docs>
        <num_found>0</num_found>
        <rows>0</rows>
        <sort>String</sort>
        <start>0</start>
      </jobs>
      <name>String</name>
      <send_frequency>0</send_frequency>
    </JobAlertsApiResponse.Data>
  </response>
</JobAlertsResponse>