Skip to content

Latest commit

 

History

History
78 lines (70 loc) · 3.66 KB

campaign-order-model.md

File metadata and controls

78 lines (70 loc) · 3.66 KB
Raw

Campaign Order Model

Structure

CampaignOrderModel

Fields

Name Type Tags Description
company_id String Required A vendor-related unique identification for the Company that's making the order. Doesn't affect the
order process at all, but provides a method for later filtering by this identification. It's also
used when creating a unified report of Campaign orders made in a period of time.
order_reference String Optional A vendor-related Reference number for the order. This could be a PO number or an Invoice number.
Doesn't affect the order process at all, but provides a way for the ATS to identify the specific
order for their internal billing process
Maximum length of this field is 80 symbols
currency String Optional An ISO 4217 code for a currency to use for order invoicing.
Currently only GBP and USD are supported. Default currency is EUR.
recruiter_info RecruiterInfoModel Required Recruiter is the user creating the campaign and you may want to use this to provide filtering by recruiter for groups sharing an account.
campaign_name String Optional Campaign name as it's going to be listed. Doesn't have to resemble the Posting Title.
For example, the Campaign name could be Software Development Manager while the Posting
title could be Want to lead a Team of Software Developers? Join us
posting_details PostingDetailsModel Required -
target_group TargetGroupModel Required -
ordered_products Array<String> Required A list of the Products selected by the user.
ordered_products_specs Array<OrderedProductsPostElementModel> Optional Specification object for some of the ordered products

Example (as JSON)

{
  "companyId": "dd1c5be0-b0e1-41c8-ba92-e876da16c38b",
  "recruiterInfo": {
    "name": "John Doe"
  },
  "postingDetails": {
    "title": "Come work for us, we're looking for amazing Software Developers",
    "description": "Are you a LEADER and a BUILDER?  Global is looking for individuals who are dynamic, sales-oriented, and who want to control their destiny.  With a full training programme and consistent support, Global will provide you with the tools to excel in this very lucrative business.",
    "organization": {
      "name": "Vonq",
      "companyLogo": "http://static.ats.com/public/vonq-company-logo.png"
    },
    "workingLocation": {
      "addressLine1": "Westblaak 175",
      "postcode": "3012 KJ",
      "city": "Rotterdam",
      "country": "The Netherlands"
    },
    "yearsOfExperience": 5,
    "employmentType": "permanent",
    "weeklyWorkingHours": {
      "to": 40
    },
    "salaryIndication": {
      "period": "yearly",
      "range": {
        "to": 60000
      }
    },
    "jobPageUrl": "http://amadeus-hospitality-it-careers.com/vacancy/software-development-manager-breda",
    "applicationUrl": "http://amadeus-hospitality-it-careers.com/vacancy/software-development-manager-breda/apply"
  },
  "targetGroup": {
    "educationLevel": {
      "description": "Element name",
      "vonqId": "23"
    },
    "seniority": {
      "description": "Element name",
      "vonqId": "23"
    },
    "industry": {
      "description": "Element name",
      "vonqId": "23"
    },
    "jobCategory": {
      "description": "Element name",
      "vonqId": "23"
    }
  },
  "orderedProducts": null
}