Monster is committed to providing our joint clients a better experience through your platform with a Real Time Posting (RTP) integration. With this integration, our joint customers may:

• Post jobs to Monster faster directly from your platform.
• Increase job visibility, including bolding and refresh.
• Add job distribution to targeted seeker groups such as veterans and diverse candidates.
• Syndicate jobs to thousands of sites through Monster Career Ad Network®.

The content below will guide you through building the best possible Real Time Posting integration for clients.

Purpose and Objective

The purpose of this guide is to help you publish, edit and delete job ads via the Monster's Business Gateway (BGW) in real time. We describe how to interact with the BGW by sending SOAP messages over HTTPS.
This technical onboarding guide is divided into the following sections:

Getting Started

Below is the Real Time Posting implementation process.

Design Considerations

Monster offers job enhancements to help employers stand out and/or target the best candidates. This section highlights key features that will differentiate your integration and offer value to joint clients.

Supported Boards Clients may choose to post to the following boards based on their available purchased inventory, as well as clients' desired distribution and targeting.
Inventory Types / Add-On Inventory Clients may add additional job visibility in job search results.
Tip! Show a snapshot of available inventory to users with the job inventory query.

Create the XML Request

Requests to BGW must be sent in the form of SOAP envelopes, which is composed of a header and a body.
Each request can include a maximum of a single job and must follow the schema for the Monster Job Postings.

• Sample Job in Monster XML Format (Click to expand XML code)

  <?xml version="1.0" encoding="UTF-8"?>

  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

    <SOAP-ENV:Header>

      <mh:MonsterHeader xmlns:mh="http://schemas.monster.com/MonsterHeader">

        <mh:MessageData>

          <mh:MessageId>Company Jobs created on 09/08/2011 02:41:44 PM</mh:MessageId>

          <mh:Timestamp>2011-09-08T14:41:44Z</mh:Timestamp>

        </mh:MessageData>

      </mh:MonsterHeader>

      <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">

        <wsse:UsernameToken>

          <wsse:Username>xrtpjobsx01</wsse:Username>

          <wsse:Password>rtp987654</wsse:Password>

        </wsse:UsernameToken>

      </wsse:Security>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

      <Job jobRefCode="myownjobreferencecode" jobAction="addOrUpdate"
      inventoryType="transactional" jobComplete="true"
      xmlns="http://schemas.monster.com/Monster"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://schemas.monster.com/Monster
      http://schemas.monster.com/Current/xsd/Monster.xsd">

        <RecruiterReference>

          <UserName>xrtpjobsx01</UserName>

        </RecruiterReference>

        <JobInformation>

          <JobTitle>Executive Officer </JobTitle>

          <JobLevel monsterId="12"/>

          <JobType monsterId="1"/>

          <JobStatus monsterId="4"/>

          <Salary>

            <Currency monsterId="1"/>

            <SalaryMin>100000.00</SalaryMin>

            <SalaryMax>150000.00</SalaryMax>

            <CompensationType monsterId="1"/>

          </Salary>

          <Contact hideAll="false" hideAddress="true" hideStreetAddress="true" hideCity="true"
          hideState="true" hidePostalCode="true" hideCountry="true" hideContactInfoField="false"
          hideCompanyName="false" hideEmailAddress="true" hideFax="true"
          hideName="false" hidePhone="true">

            <Name>John</Name>

            <CompanyName>John's Company</CompanyName>

            <Address>

              <StreetAddress>1 John Street</StreetAddress>

              <StreetAddress2>PO Box 1</StreetAddress2>

              <City>Johnstown</City>

              <State>PA</State>

              <CountryCode>US</CountryCode>

              <PostalCode>15955</PostalCode>

            </Address>

            <Phones>

              <Phone phoneType="work">999-999-9999</Phone>

            </Phones>

            <E-mail>john@johnscompany.com</E-mail>

          </Contact>

          <PhysicalAddress>

            <StreetAddress>5 Clock Tower</StreetAddress>

            <StreetAddress2>Suite 500</StreetAddress2>

            <City>Maynard</City>

            <State>MA</State>

            <CountryCode>US</CountryCode>

            <PostalCode>01754</PostalCode>

          </PhysicalAddress>

          <DisableApplyOnline>false</DisableApplyOnline>

          <HideCompanyInfo>false</HideCompanyInfo>

          <JobBody>This is the Job Body that needs to be of certain length. 
          This is more information about the Job.
          It should be detailed and well written to attract seekers.
          </JobBody>

          <AdditionalSearchKeywords>additional search keyword
          </AdditionalSearchKeywords>

          <EducationLevel monsterId="1"/>

        </JobInformation>

        <JobPostings>

          <JobPosting desiredDuration="60" bold="true">

            <InventoryPreference>
              <Autorefresh desired="true">

                <Frequency>7</Frequency>

              </Autorefresh>

              <CareerAdNetwork desired="true">

                <Duration>14</Duration>

              </CareerAdNetwork>
             </InventoryPreference>

            <Location>

              <City>Boston</City>

              <State>MA</State>

              <CountryCode>US</CountryCode>

              <PostalCode>02125</PostalCode>

            </Location>

            <JobCategory monsterId="47"/>

            <JobOccupations>

              <JobOccupation monsterId="11909"/>

            </JobOccupations>

            <BoardName monsterId="1"/>

            <DisplayTemplate monsterId="1"/>

            <Industries>

              <Industry>

                <IndustryName monsterId="1"/>

              </Industry>

            </Industries>

            <Video monsterId="123" refCode="video_A">

            </Video>

          </JobPosting>

        </JobPostings>

      </Job>

    </SOAP-ENV:Body>

  </SOAP-ENV:Envelope>
   
• Information about Job Fields (Click to expand XML code)

  Field Name	Requirement	Data Type	Constraints	Notes
  Username	Required	String		Value provided by Monster
  Password	Required	String		Value provided by Monster
  jobRefCode	Required	String	<= 50 characters	Recruiter specific term used to uniquely identify job.
  jobAction	Optional	String	Common choices are: addOrUpdate add delete Full list of valid entries can be found in schema at  Job Schema	Recommend using “addOrUpdate” as this allows new ads to be posted and updates to active jobs. “add” allows new ads to be posted. Updates to active jobs not allowed.
  InventoryType	Optional	String	Choices are: transactional areaWideTransactional areaWideSlotted slotted	This field specifies the type of inventory that should be used to post the job.  Most customers will use transactional inventory. If no inventory is specified, the account's default settings will be used.
  RecruiterReference\UserName	Required	String		Value provided by Monster
  JobTitle	Required	String	<= 100 characters
  JobLevel attribute: monsterId	Optional	Integer	A list of valid entries can be found at: JobLevel list
  JobType attribute: monsterId	Optional	Integer	Valid entries for the US Channel: 1 - Employee 2 - Temporary/Contract 3 - Intern 20 - Seasonal Entries for other channels can be found at: JobType list	EducationLevel has to be specified when JobType Apprenticeship is used.
  JobStatus attribute: monsterId	Required	Integer	A list of valid entries can be found at: JobStatus list
  Salary	Optional
  Contact attribute: HideAll	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides contact given and family name, company name, street address, street address2, city, state, postal code, phone, fax when viewing a job.
  Contact attribute: HideAddress	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides contact street address, street address2, city, state and postal code when viewing a job.
  Contact attribute: HideStreetAddress	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides street address only (NOT street address2) when viewing a job.
  Contact attribute: HideCity	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides city when viewing a job.
  Contact attribute: HideState	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides State when viewing a job.
  Contact attribute: HidePostalCode	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides postalcode when viewing a job.
  Contact attribute: HideCountry	Optional	Boolean	true or false (case sensitive!)	No impact as country is not shown in standard job template.
  Contact attribute: HideContact	Optional	Boolean	true or false (case sensitive!)	No impact.
  Contact attribute: HideEmailAddress	Optional	Boolean	true or false (case sensitive!)	No impact as email address is not displayed when viewing a job.
  Contact attribute: HideFax	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides fax number when viewing a job.
  Contact attribute: HideName	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides given name and family name when viewing a job.
  Contact attribute: HidePhone	Optional	Boolean	true or false (case sensitive!)	When set to “true”, hides given name and family name when viewing a job.
  Contact\Name	Optional	String	<= 255 characters
  Contact\  CompanyName	Optional	String	<= 255 characters	JobSearch: Whether provided or not, if company name on account is not an ad agency, the company name on the account will be displayed in job search results. If provided and if company name on account is an ad agency, this company name is displayed as company name in job search results. JobView: If provided, this is company name that will be displayed when viewing a job. If not provided, company name on account will be displayed.
  Contact\Address	Optional
  Phones	Optional	String	Between 8 and 50 characters	Has to be either “contact” or “fax” type to be displayed. Other phone types can be provided but will not be displayed.
  E-mail	Optional	String	<= 100 characters	Only one allowed per job posting.
  PhysicalAddress	Optional			Represents a job’s physical location. Controls the visible location information that is displayed on the job posting Controls how the job is pulled up in the job search results. Typically includes <City>, <State>, <CountryCode> and <PostalCode>. <StreetAddress> and  <StreetAddress2> may be provided as well.
  DisableApplyOnline	Optional	Boolean	true or false (case sensitive!)	When set to “false”, allows job seekers to apply for the job online. When set to “true”, job seekers will not be able to apply for the job online.
  HideCompanyInfo	Optional	Boolean	true or false (case sensitive!)	When set to “true”, company name in job search results and top portion of job view show as confidential. Hides company name in “Job Summary” and “Contact Information” sections of job view.
  JobBody	Required	String	>= 25 characters
  AdditionalSearchKeywords	Optional	String	<= 255 characters
  EducationLevel attribute: monsterId	Optional	Integer	A list of valid entries can be found at: EducationLevel list
  JobPostings	Required
  JobPosting attribute: DesiredDuration	Optional	Integer	# of days	Highly recommended that this field be supported
  JobPostings attribute: Bold	Optional	Boolean	true or false (case sensitive!)	A true value will bold the job title in job search results.
  JobPostings attribute: jobPostingAction	Optional	String	Value of “refresh”	Makes the job refresh (move to the top of job search results)
  CareerAdNetwork attribute: desired	Optional	Boolean	true or false (case sensitive!)	A true value will set CAN (Career Ad Network ) on the job. CAN allows one to enhance Monster Job Posting with targeted advertising on the Monster network and its diverse partner websites.
  CareerAdNetwork\Duration	Only required when desired attribute=1	Integer	# of days: 7, 14 or 30
  Autorefresh attribute: desired	Optional	Boolean	true or false (case sensitive!)	A true value will make the job refresh (move to the top of job search results) in 14 days
  Autorefresh\    Frequency	Only required when desired attribute= true	Integer	# of days: 7, 14, 30, 60	Not available on 7 day job postings.
  JobPosting\    Location	Required			Controls what Monster search location the job is going to be posted to
  JobCategory	Required		A list of valid job categories can be found at: JobCategory list
  JobOccupation	Required		A list of valid occupationId’s for given job categories can be found at: JobOccupation list	Can contain a minimum of one and a maximum of three per job. Recommend the use of "other" occupation be minimized.
  BoardName attribute: monsterId	Required	Integer	1 is value for Monster core job board	See Job Board section below for other board Id values.
  DisplayTemplate attribute: monsterId	Optional	Integer	1 is value for Monster standard job template	Contact Monster Representative for custom job templates.
  Industry	Optional		Valid entries can be found at: Industry list	If submitted, can provide a minimum of one and a maximum of three per job.
  Video attribute: monsterId	Optional	Integer		Value provided by Monster

SOAP Envelope

The envelope is a container for Soap message.

(Click to Expand XML Code)

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

  <SOAP-ENV:Header>

  </SOAP-ENV:Header>

  <SOAP-ENV:Body>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Monster SOAP Schema can be found here

SOAP Header

The header contains information about the request, request protocol, and a security protocol with the user credentials.

(Click to Expand XML Code)

    <mh:MonsterHeader xmlns:mh="http://schemas.monster.com/MonsterHeader">

      <mh:MessageData>

        <mh:MessageId>Company Jobs created on 09/08/2011 02:41:44 PM</mh:MessageId>

        <mh:Timestamp>2011-09-08T14:41:44Z</mh:Timestamp>

      </mh:MessageData>

    </mh:MonsterHeader>

    <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">

      <wsse:UsernameToken>

        <wsse:Username>username</wsse:Username>

        <wsse:Password>password</wsse:Password>

      </wsse:UsernameToken>

    </wsse:Security>

Monster Header Schema can be found here

SOAP Envelope Job

The Body contains all the data related to the job you're posting and should comply with Monster job schema.

• Job request samples can be found here.
• The full Monster Job Schema can be found here.

The XML job is described by 3 main sections

• Processing Information
• Job Information
• Job Posting

Processing Information

This section contains information about the way the Job Message will be processed, under which account e.g. information about the kind of action (update, delete, etc...)

(Click to Expand XML Code)

<Job jobRefCode="myownjobreferencecode" jobAction="addOrUpdate" jobComplete="true"
xmlns="http://schemas.monster.com/Monster"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://schemas.monster.com/Monster
http://schemas.monster.com/Current/xsd/Monster.xsd">

      <RecruiterReference>

        <UserName>username</UserName>

      </RecruiterReference>

<!−− [CONTINUES...] −−>

 

Job Information

This contains the main information that will be displayed in the job ad. Example: job title, job description (jobBody), salary , contact, etc.

(Click to Expand XML Code)

    <JobInformation>

        <JobTitle>Executive Officer </JobTitle>

        <JobLevel monsterId="12"/>

        <JobType monsterId="1"/>

        <JobStatus monsterId="4"/>

        <Salary>

          <Currency monsterId="1"/>

          <SalaryMin>100000.00</SalaryMin>

          <SalaryMax>150000.00</SalaryMax>

          <CompensationType monsterId="1"/>

        </Salary>

        <Contact hideAll="false" hideAddress="true" hideStreetAddress="true" hideCity="true"
        hideState="true" hidePostalCode="true" hideCountry="true" hideContactInfoField="false"
        hideCompanyName="false" hideEmailAddress="true" hideFax="true"
        hideName="false" hidePhone="true">

          <Name>John</Name>

          <CompanyName>John's Company</CompanyName>

          <Address>

            <StreetAddress>1 John Street</StreetAddress>

            <StreetAddress2>PO Box 1</StreetAddress2>

            <City>Johnstown</City>

            <State>PA</State>

            <CountryCode>US</CountryCode>

            <PostalCode>15955</PostalCode>

          </Address>

          <Phones>

            <Phone phoneType="work">999-999-9999</Phone>

          </Phones>

          <E-mail>john@johnscompany.com</E-mail>

        </Contact>

        <PhysicalAddress>

          <StreetAddress>5 Clock Tower</StreetAddress>

          <StreetAddress2>Suite 500</StreetAddress2>

          <City>Maynard</City>

          <State>MA</State>

          <CountryCode>US</CountryCode>

          <PostalCode>01754</PostalCode>

        </PhysicalAddress>

        <DisableApplyOnline>false</DisableApplyOnline>

        <HideCompanyInfo>false</HideCompanyInfo>

        <JobBody>This is the Job Body that needs to be of certain length. 
        This is more information about the Job.
        It should be detailed and well written to attract seekers.
        </JobBody>

        <AdditionalSearchKeywords>additional search keyword
        </AdditionalSearchKeywords>

        <EducationLevel monsterId="1"/>

    </JobInformation>

Job Posting

This section sets where the job posting will be searchable, identified by the combination of JobCategory, JobOccupation, Location and BoardName. Inventory preferences, industries, video, etc can be set in this section as well.

(Click to Expand XML Code)

    <JobPosting desiredDuration="60" bold="true">

          <InventoryPreference>
            <Autorefresh desired="true">

              <Frequency>7</Frequency>

            </Autorefresh>

            <CareerAdNetwork desired="true">

              <Duration>14</Duration>

            </CareerAdNetwork>
          </InventoryPreference>

          <Location>

            <City>Boston</City>

            <State>MA</State>

            <CountryCode>US</CountryCode>

            <PostalCode>02125</PostalCode>

          </Location>

          <JobCategory monsterId="47"/>

          <JobOccupations>

            <JobOccupation monsterId="11909"/>

          </JobOccupations>

          <BoardName monsterId="1"/>

          <DisplayTemplate monsterId="1"/>

          <Industries>

            <Industry>

              <IndustryName monsterId="1"/>

            </Industry>

          </Industries>

          <Video monsterId="123" refCode="video_A">

          </Video>

    </JobPosting>        

Job Duration

The job duration defines how many days an ad will run. When added, it controls the desired duration to attempt to post the job with.  Jobs will require inventory with the appropriate duration or else the job will fail to post.

(Click to Expand XML Code)

Location

This is the location (region or part of it, down to the postal code level) under which the job will be searchable on Monster sites. This will restrict the website on which it will be searchable.
Example locations: London East, London North West, etc... full available location can be found here: Monster Locations

Job Board

The job board is a container in which your jobs will fall into. It is specified in the BoardName element.
For example, Id 1 represents the production core Monster sites, excluding Private Label sites ( also known as "Co-branded" sites or "Branded Career Sites") that have their own BoardId.

The following table shows the different test and production board Ids.

To post to both Monster and Diversity, two job postings must be provided in the request. This sample can be used as a reference as it shows multiple postings: Multiple_Postings_Sample

DisplayTemplate

The DisplayTemplate defines which job template is used to used to format the posting ad. Id value of 1 is for the standard job posting template offered by Monster. Other Id values are for customized job posting templates.

Bolding

When added, bolds the job title in seeker job search results, increasing the visibility of the job. Bolding exists as both as an attribute for standard inventory and as an ala carte option. Setting bold to “true” will require available bolding inventory or else the job will fail to post.

In the job XML, bolding is defined as a Boolean attribute of the JobPosting element, as shown below: 

Job Refresh

When added, refresh provides the ability to do a manual, “one time” refresh on an active job posting. Inventory is purchased only ala carte. Setting the jobPostingAction to “refresh” will require available refresh inventory or else the job will fail to refresh.

In the job XML, Refresh is defined as an enumeration value of the attribute jobPostingAction of the JobPosting element, as shown below:

Auto-Refresh

When added, auto-refresh provides the ability for a job posting to be moved to the top of the job search results every "auto-refresh interval" days. Valid auto-refresh frequencies are: 7, 14, 30 or 60 days. Auto-refresh inventory exists only as an attribute for standard inventory. Setting the Auto-refresh to “true” will require available auto-refresh inventory for the selected frequency or else the job will fail to refresh.

(Click to Expand XML Code)

Video

When added, Video provides the ability to have a job video that accompanies the job posting. Inventory is purchased only ala carte. Setting Video on a job will require available video inventory or else the job will fail to post, Setting Video on a job will require available video inventory or else the job will fail to post.

CAN (Career Ad Network)

When added, allows one to enhance Monster Job Posting with targeted advertising on the Monster network and its diverse partner websites. Monster’s Career Ad Network will transform a job posting into a dynamic hiring ad and then strategically place that ad where qualified candidates spend their time online. When interested job seekers click on the ad, they’ll be brought to the Monster Job Posting, where they can learn more about the job and easily apply online. Inventory is purchased ala carte for Monster postings only. It is not available on Diversity. Setting CAN on a job will require available CAN inventory or else the job will fail to post.

Apply Methods

Character sets and encoding

XML requests should be posted to BGW encoded in "UTF-8" (Unicode) characters set.


More information about HTML Encoding can be found here: http://en.wikipedia.org/wiki/Character_encodings_in_HTML

Job Processing

The jobAction attribute within Job Tag is used to determine the action your request will trigger.

Adding a new job

Posting a request with jobAction="addOrUpdate" will add a new job, or update a pre-existing one if a job with such a RefCode exists under the referred recruiter account.

An alternative way of posting a new job is by using jobAction="add", but this is not recommended. In the case that the job already exists with this JobRefCode, it will return an error in the XML Response.

Updating a job

Posting a request with jobAction="addOrUpdate" will update a pre-existing job with such a jobRefCode under the referred recruiter account.

An alternative way of updating a job posting is by using jobAction="update", but this is not recommended. In the case that a job does not already exist with this jobRefCode, it will return an error in the XML Response.

Deleting a job

There are two ways to delete a job position:

1. Set the job action attribute, in your request (the same XML format as for adding or updating) to delete (<Job... jobAction="delete"...>) including the targeted JobRefCode and RecruiterReference.

2. Post a Delete XML request with RefCode as the job identifier

Monster Delete Schema can be found here: http://schemas.monster.com/Current/XSD/Delete.xsd

(Click to Expand XML Code)

Job postings Processing

An XML job request can contain multiple postings for the same job position.

Each of the posting will be referred by the unique combination of JobCategory/Location/BoardName
Each posting will get a Monster postingId and will consume a posting Inventory from the recruiter account

Adding a new posting

Add a new posting to the request(include the existing posting) with jobaction set to "addOrUpdate" or "Update" and repost it. This will add a new posting under the same position.

Updating a posting

Update the posting info on the request setup jobAction to "addOrUpdate" or "Update" and repost it.

Changing one of the key entities (JobCategory/Location/BoardName) on a posting will cause it to be deleted and to add a new posting, or update the existing posting if this combination key already exist under the position.

Deleting a posting

There are two ways to delete a single posting:

1. Omitting a posting from the job request with jobAction set to "addOrUpdate" or "Update" and reposting it will cause this position to be deleted.

2. Posting a delete XML request with postingId as the posting identifier

Monster Delete Schema can be found here: http://schemas.monster.com/Current/XSD/Delete.xsd

(Click to Expand XML Code)

Testing

Here are suggestions for testing your Real Time Posting integration with Monster


Take Note!
Different job boards are used for integration testing and Monster's production job boards. Be sure that the appropriate job boards are used for the intended destination.

HTTPS response

For each request, the BGW will return an XML response that will contain information about the success or failure of the request.

Common Job Errors and Resolutions can be found here.

Deployment