{"info":{"_postman_id":"3862ca07-4a2d-4b7b-9a28-6c48eb0f7af9","name":"CareerOne Business Gateway (Partners)","description":"

The CareerOne Business Gateway is an adaptation of the legacy Monster powered Business Gateway. It is backward compatible and aims to assist in the transition from the legacy Monster taxonomy to CareerOne's current taxonomy.

\n

For more powerful functionality and control, we advise migrating to our new job posting api, the CareerOne Job Gateway.

\n

The below values will be provided with the setup of your API access:

\n

These values are used for all requests from an integration partner app.

\n\n

These values are used to authenticate an individual CareerOne posting account.

\n\n

There is one general API endpoint with 2 actions, 'addOrUpdate' and 'delete', which are specified in the request body. Updates to existing job ads can be made by sending all data again, including the updates to be made, and using the same jobRefCode as the original post.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4936443","collectionId":"3862ca07-4a2d-4b7b-9a28-6c48eb0f7af9","publishedId":"2s93Y2T2Jz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-04-19T23:42:11.000Z"},"item":[{"name":"bgwCreate","id":"ca3497ce-cd70-4c4c-95e5-5031547a210a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n {{username}}\r\n {{password}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 1000\r\n 3000\r\n \r\n \r\n \r\n \r\n \r\n \r\n John\r\n \r\n \r\n \r\n \r\n false\r\n \r\n
  • Great opportunity
  • Competitive salary
  • Great perks
    • ]]>\r\n     \r\n \r\n The job:
    Job description details here

    Selection Criteria:
    Selection criteria here.

    ]]>\r\n     \r\n \r\n \r\n \r\n \r\n \r\n \r\n     \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n     \r\n     \r\n    "},"url":"{{hostname}}/api/v1/bgw/{{channel_token}}","description":"

    The addOrUpdate action is used to post a new job ad or update an existing job ad.

    \n

    Updates to existing job ads can be made by sending all data again, including the updates to be made, and using the same jobRefCode as the original post.

    \n

    Job ads require available inventory to be accepted, else \"Insufficient inventory.\" message will be returned.

    \n

    The max payload size is 2MB. This roughly equates to 50 large job descriptions or 200 relatively standard sized jobs. If the payload is determined by number of jobs rather than payload size, then 50 jobs is a safe number.

    \n

    Field Definitions

    \n

    Click to expand

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Field Name/Tag NameForm LabelUsageRequiredData TypeExample Value
    jobActionN/APlace inside the Jobs tag
    Add' or 'Update' or 'Delete'    		YString\"addOrUpdate\"
    jobRefcodeN/APlace inside the Jobs tag
    Used to reference the job ad for update and deletion. Post actions to same jobRefCode will result in an update of the existing job ad    		YString\"j_2342125\"
    JobTitleJob titlePlace inside the JobInformation tag
    Job title to be matched for searches and displayed on posting. Do not include other attributes like location or job type.    		YString\"Registered Nurse\"
    JobType idJob typePlace inside the JobInformation tag. This is used to specify job types such as \"Full Time\", \"Part Time\" etc. Refer to the CareerOne taxonomy.YInteger2
    ContractType idContract typePlace inside the JobInformation tag. This is used to specify contract types such as \"Permanent\", \"Temporary\" etc.YInteger14
    Salary hideSalaryHide pay rangeHides pay range but not pay description. Pay range will still be used to return in searches that match pay range. Displayed by defaultYboolean\"false\"
    PayType idPay typePlace inside the tag Salary . To specify how the pay range is described. 1 = Annual, 2 = Hourly.YInteger3
    SalaryMinPay range min.Place inside the tag Salary .
    To set the pay range    		YInteger80000
    SalaryMaxPay range maxPlace inside the tag Salary .
    To set the pay range    		YInteger90000
    AdditionalInformationPay informationPlace inside the tag Salary .
    To display on the posting to give more pay information    		NString\"+Bonuses\"
    NotificationsContactNameNotification contact namePlace inside the tag Contact.
    Used when sending communications from CareerOne to the poster of the job ad.    		NString\"Willem Dafoe\"
    NotificationsContactEmailNotification emailPlace inside the tag Contact.Used to send communications from CareerOne to the poster of the job ad.YString\"name@company.com.au\"
    HideCompanyInfoPost as private listingHide the brand/company details on the posting, but still allow the company to be set for reporting purposes.Yboolean1 (hide) or 0 (show)
    JobBodyJob descriptionThe main job body/description. Allowable HTML tags are \"p\", \"b\",\"i\", \"strong\", \"em\", \"ul\", \"ol\", \"li\", \"br\". All other tags will be stripped. Json character escaping should be used.YString\"This is the job body\"
    CustomApplyOnlineURLN/AThe URL which applicants are redirected to. If none supplied, apply with be taken onsite and a notice of application will be sent to NotificationsContactEmailNString\"https://apply.careerone.com.au/job\\\\_id=testing123\"
    DisplayTemplate idBrand or TemplatePlace inside the JobPosting tag.
    Used to assign a predefined brand and related brand material to a job ad. Branding information will not show on the live job ad if HideCompanyInfo is \"true\".

    A list of brands and their associated brand ids can be accessed via the Brands section of the client's CareerOne hiring portal account.    		NString123456
    jobCategory idCategoryPlace inside the JobPosting tag. Category seekers will find this job in. Refer to CareerOne taxonomy.YInteger12
    JobOccupation idOccupationPlace inside the JobPosting tag. Occupation must belong to the chosen Category. Refer to CareerOne taxonomyNInteger181
    ApplyEmailApplication emailThe email address where applications are sent to.NStringapply@genericats.com.au
    JobBodyJob descriptionThe main job body/description. Allowable HTML tags are \"p\", \"b\",\"i\", \"strong\", \"em\", \"ul\", \"ol\", \"li\", \"br\". All other tags will be stripped. Json character escaping should be used.YString\"

    This is the \\\"Job Description\\\".

    \"
    Location idLocationUsed to match seeker searches. A broad area will be matched for searches for suburbs within, but will be give less priority. Refer to CareerOne taxonomy.YString15207
    \n

    Typical Job Posting process

    \n

    Step 1: Post ad > Select job boards > Board fields > Preview

    \n\n\n

    Step 2: Post ad > Select job boards > Board fields > Preview:

    \n\n\n

    Step 3: Post ad > Select job boards > Board fields > Preview:

    \n","urlObject":{"path":["api","v1","bgw","{{channel_token}}"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"45242d6e-afc5-4dd0-ad90-265ee196a345","name":"bgwCreate - Application on CareerOne","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n {{username}}\r\n {{password}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 1000\r\n 3000\r\n \r\n \r\n \r\n \r\n \r\n \r\n John\r\n \r\n \r\n \r\n \r\n false\r\n Best Recruitment\r\n \r\n
  • Great opportunity
  • Competitive salary
  • Great perks
    • ]]>\r\n     \r\n \r\n The job:
    Job description details here

    Selection Criteria:
    Selection criteria here.

    ]]>\r\n     \r\n \r\n \r\n \r\n     \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n     \r\n     \r\n    ","options":{"raw":{"language":"xml"}}},"url":"{{hostname}}/api/v1/bgw/{{channel_token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 15 May 2019 01:17:36 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=P4zsHiaIgC28LF0N21HU6T7sxtI3gGUI7JWpLH0Ar/mrXQK49ABQK688RrbJLB5oqP6xYl1TEJYzVIMfJ3TXfk72oiaoZ+mk5RnYlqrSWDBW53gZ/KqjcBkCzB5D; Expires=Wed, 22 May 2019 01:17:36 GMT; Path=/"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"496"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n 58\n \n 1557883056\n 2019-05-15T01:17:36.375939+00:00\n Company Jobs created on 2019-05-15 01:17:36\n \n \n \n \n \n \n {http://schemas.monster.com/Monster}JobResponse\n \n 0\n \n \n \n \n \n 2019-05-15T01:17:36.375983+00:00\n 2019-06-14T01:17:36.375994+00:00\n \n \n \n 0\n \n \n Job added.\n \n \n \n \n \n \n"},{"id":"11d91e9b-269d-4547-b7f2-376f68d911c0","name":"bgwCreate - Application on advertiser's site","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\t{{username}}\r\n\t\t\t\t{{password}}\r\n\t\t\t\r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t1000\r\n\t\t\t\t\t3000\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\tJohn\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\tfalse\r\n\t\t\t\tBest Recruitment\r\n \r\n
  • Great opportunity
  • Competitive salary
  • Great perks
    • ]]>\r\n     \r\n\t\t\t\t\r\n The job:
    Job description details here

    Selection Criteria:
    Selection criteria here.

    ]]>\r\n     \t\t\t\t\r\n \r\n\t\t\t    \r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t    \r\n\t    \r\n    ","options":{"raw":{"language":"xml"}}},"url":"{{hostname}}/api/v1/bgw/{{channel_token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 15 May 2019 01:19:43 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=ywe1gGgnuFGDneeHRI6PGr41hTqn5r3ovcp1mQXt4JmC16mnNDspwv27vWptSuqFlmGHApt+pk2ZhIbn5T+2tVTkv8IsTJnsn8jAr0rInhOtdzd/y1yYWS7tB5tn; Expires=Wed, 22 May 2019 01:19:42 GMT; Path=/"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n 58\n \n 1557883183\n 2019-05-15T01:19:43.035888+00:00\n Company Jobs created on 2019-05-15 01:19:43\n \n \n \n \n \n \n {http://schemas.monster.com/Monster}JobResponse\n \n 0\n \n \n \n \n \n 2019-05-15T01:19:43.035936+00:00\n 2019-06-14T01:19:43.035947+00:00\n \n \n \n 0\n \n \n Job updated.\n \n \n \n \n \n \n"}],"_postman_id":"ca3497ce-cd70-4c4c-95e5-5031547a210a"},{"name":"bgwDelete","id":"6add651d-bb2c-4ea9-bbe7-46437e5aca72","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n {{username}}\r\n {{password}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"},"url":"{{hostname}}/api/v1/bgw/{{channel_token}}","description":"

    Delete should be used to expire the job posting early or take the posting offline if necessary. Jobs will typically automatically expire after 30 days, but will remain archived online.

    \n

    Field Definitions

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    FieldUsageRequiredData TypeExample
    jobRefCodePlace inside the tag Job .Used to reference the posting for deletion.YString\"12345-6789\"
    jobActionPlace inside the tag Job.Deletes a job based on the job reference IDYString\"delete\"
    \n
    ","urlObject":{"path":["api","v1","bgw","{{channel_token}}"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[{"id":"9b2d4add-1b47-4e0a-ae9f-98c6ef48dbbb","name":"bgwDelete","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\t{{username}}\r\n\t\t\t\t{{password}}\r\n\t\t\t\r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n","options":{"raw":{"language":"xml"}}},"url":"{{hostname}}/api/v1/bgw/{{channel_token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 15 May 2019 02:04:33 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=ISJNceIPM1YytOyf8GSG6Xh3lt51dYBnzlHGEPT5Jut8aP89QGj/BQG5eQ3O0FhpcuffHAZYsSGgp53zmlAJtbzbNF0dmV2LRkVTr4CSPbujYKMZ6zGrpEhH3k+C; Expires=Wed, 22 May 2019 02:04:33 GMT; Path=/"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n 58\n \n 1557885873\n 2019-05-15T02:04:33.597889+00:00\n Company Jobs created on 2019-05-15 02:04:33\n \n \n \n \n \n \n {http://schemas.monster.com/Monster}JobResponse\n \n 0\n \n \n \n \n \n 2019-05-15T02:04:33.597933+00:00\n 2019-06-14T02:04:33.597944+00:00\n \n \n \n 0\n \n \n JobPosting 4a0cbf25-3b79-40d0-b569-0cf77fc5074e expired.\n \n \n \n \n \n \n"}],"_postman_id":"6add651d-bb2c-4ea9-bbe7-46437e5aca72"}]}