Sender info
Part of the core data that goes under the <job> element are the fields that identify the User who owns the job. A User (sometimes referred to as "Profile" or "Sender") is a sub-entity of a Client account - one that identifies the individual consultant who creates the posting and later receives (and manages) Applicants.
The standard and ideal approach is that User Management Webservice is used to create and manage Users. With that, all you need to define the sender of the job is to include their id as an attribute of the <sender> element.
Otherwise, the <sender> tag can be used to automatically create a new user or identify an existing one. In such a scenario, <sender> needs to be used as a parent element for the data outlined below.
This block only applies to the Add, Repost, and Clone methods; however, the original <sender> who created the Job cannot be changed when using repost.
Fields description
| XML element | Type restrictions | Required? | Notes |
|---|---|---|---|
title | String (enum) Accepted values: MrMrsMs | No | User's title |
name | String | Yes | User's first name |
lastname | String | Yes | User's last name (surname) |
email | String | Yes | User's email address Should be unique for each User on the Client account |
company | String | Yes, if creating a new User | Company name |
www | String | Yes, if creating a new User | Company website |
phone | String | Yes, if creating a new User | User's phone number |
fax | String | No | User's fax number |
address1 | String | Yes, if creating a new User | Address line 1 |
address2 | String | No | Address line 2 |
address3 | String | No | Address line 3 |
country | String | Yes, if creating a new User | Address - country |
postcode | String | Yes, if creating a new User | Address - postcode (zip code) |
team | String (enum) Accepted values obrainable via the User Management webservice | No | ID of the Team to which the User should be assigned. Use the User Management webservice to control and obtain the available Users, Teams, and Offices. Must be provided as an id attribute of the <team> element. |
expiryemails | String (enum) Default: noAccepted values: yes - alert the user via email whenever their Posts expire on any Portalno - do not alert the user after their Posts expire | No | A setting that controls whether the system should send Post expiry alerts to the User's email. |
Format
The format below details the full <sender> section that goes under the <job> element. If you just wish to specify the id of an existing User, refer to the format outlined in Job Section.
<sender>
<title>["Mr"|"Mrs"|"Ms"]</title>
<name>[string]</name>
<lastname>[string]</lastname>
<email>[string:email]</email>
<company>[string]</company>
<www>[string:url]</www>
<phone>[string:phone]</phone>
<fax>[string:phone]</fax>
<address1>[string]</address1>
<address2>[string]</address2>
<address3>[string]</address3>
<country>[string]</country>
<postcode>[string]</postcode>
<team id="[integer]" />
<expiryemails>["yes"|"no"]</expiryemails>
</sender>
Example
The example below details the full <sender> section that goes under the <job> element. If you just wish to specify the id of an existing User, refer to the example provided in Job Section.
<sender>
<title>Mr</title>
<name><![CDATA[Test]]></name>
<lastname><![CDATA[User]]></lastname>
<email>test@example.com</email>
<company><![CDATA[Test company]]></company>
<www><![CDATA[https://www.example.com]]></www>
<phone>1234567890</phone>
<fax>0987654321</fax>
<address1>Test address</address1>
<address2>Test street</address2>
<address3>Test area</address3>
<country>United Kingdom</country>
<postcode>SW1A 2AA</postcode>
<team>67890</team>
<expiryemails>yes</expiryemails>
</sender>