MediaConnect AS
Powered by Redocly

Recruitment

Register recruitment - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

Use this API to register recruitments. The recruiter and the persons recruited are created in Connect. A recruitment is processed as an order in Connect.

SecurityClient_Credentials
Request
Request Body schema: application/json
product
required
string <= 12 characters

Product code. The product must be a subcription product.

campaign
required
string <= 12 characters

Campaign code

required
object

The recruiter

Array of objects
  • Missing list, i.e element missing, cause no changes in existing premium preferences.
  • List (empty or not) result in replacing existing premium preferences, i.e empty list will remove all premium preferences.
required
Array of objects
Responses
200

OK

Response Schema: application/json
status
string

The value "ok" if the request was received and processed successfully.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/recruitment
Request samples
application/json
{
  • "product": "CO27409",
  • "campaign": "Spring2019",
  • "recruiter": {
    },
  • "recruitmentPremiumPreferences": [
    ],
  • "recruitments": [
    ]
}
Response samples
application/json
{
  • "status": "ok"
}

List recruitments

The user needs to be logged in to use this endpoint, click here to read more.

Use this API for fetching existing recruitments and available points.

SecurityAuthorization_Code
Request
path Parameters
campaign
required
string <= 12 characters

Campaign code

query Parameters
limit
integer
Default: 50

Limit the number of records returned.

offset
integer
Default: 0

Offset the records returned.

ascending
boolean

Sort ascending or descending.

Responses
200

OK

Response Schema: application/json
points
integer

Number of points for this customer

products
Array of strings

List of proucts valid for recruitment on this campaign

Array of objects

List of recruitments

Array of objects

List of unverified recruitments

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/recruitment/{campaign}
Request samples 
Response samples 
application/json
{
  • "points": 50,
  • "products": [
    ],
  • "recruitments": [
    ],
  • "unverifiedRecruitments": [
    ]
}
List premium recruitments
The user needs to be logged in to use this endpoint, click here to read more.


Use this API for premium preferences.


SecurityAuthorization_Code 
Request 
path Parameters
campaign
required
string  <= 12 characters 
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/recruitment/premium/{campaign}
Request samples 
Response samples 
application/json
{
  • "recruitmentPremiumPreferences": [
    ]
}
Change premium recruitments
The user needs to be logged in to use this endpoint, click here to read more.


Use this API for updating premium preference.


NOTE: Any existing premium preferences on this recruiter will be deleted before the POSTed data is applied


SecurityAuthorization_Code 
Request 
path Parameters
campaign
required
string  <= 12 characters 
 
Request Body schema: application/json
Array of objects
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/recruitment/premium/{campaign}
Request samples 
application/json
{
  • "recruitmentPremiumPreferences": {
    }
}
Response samples 
application/json
{
  • "recruitmentPremiumPreferences": [
    ]
}
Register recruitments
The user needs to be logged in to use this endpoint, click here to read more.


Use this API to register recruitments. The recruiter and the persons recruited are created in Connect. A recruitment is processed as an order in Connect.


    

  • If the recruiter, i.e the ConnectID user, is registered to a customer in Connect, we use this customer as the recruiter. In this case we ignore the recruiter information given in the request (i.e name and address).
    • 

  • Otherwise the recruiter is created in Connect if no matching customer is found.
    • 



SecurityAuthorization_Code 
Request 
Request Body schema: application/json
product
required
string  <= 12 characters 
 
campaign
required
string  <= 12 characters 
 
object
 
Array of objects
 
required
Array of objects
 The coupon must belong to the given product in the recruitment request.


 
Responses 
200
OK


Response Schema: application/json
status
string
The value "ok" if the request was received and processed successfully.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/recruitment
Request samples 
application/json
"{\n    \"product\": \"CO27409\",\n    \"campaign\": \"Spring2019\",\n    \"recruiter\": {\n        \"name\": {\n            \"firstName\": \"Kari\",\n            \"middleName\": \"Snøhaug\",\n            \"lastName\": \"Nordmann\"\n        },\n        \"address\": {\n            \"streetAddress\": \"Osloveien\",\n            \"streetNumber\": 12,\n            \"entrance\": \"B\",\n            \"floor\": 3,\n            \"postalCode\": \"0101\",\n            \"postalPlace\": \"Oslo\",\n            \"postalAddress\": \"Postboks 6\",\n            \"postalAddressPostalCode\": \"0216\",\n            \"postalAddressPostalPlace\": \"Oslo\",\n            \"countryCode\": \"NO\"\n        },\n        \"phoneNumber\": \"+4787654321\",\n        \"email\": \"kari.nordmann@gmail.com\"\n        \"customerNumber\": 34272\n    },\n    \"recruitmentPremiumPreferences\": [\n        {\n            \"companyCode\": \"468979834\",\n            \"product\": \"HS3829\",\n            \"preferenceNumber\": 1\n        }\n    ],\n    \"recruitments\": [\n        {\n            \"name\": {\n                \"firstName\": \"Ola\",\n                \"middleName\": \"Fjordstrand\",\n                \"lastName\": \"Nordmann\",\n                \"companyName\": \"Company International Ltd\",\n                \"departmentName\": \"Support\"\n            },\n            \"address\": {\n                \"streetAddress\": \"Grubbegata\",\n                \"streetNumber\": 6,\n                \"entrance\": \"A\",\n                \"floor\": 6,\n                \"postalCode\": \"0179\",\n                \"postalPlace\": \"Oslo\",\n                \"postalAddress\": \"Postboks 265 Økern\",\n                \"postalAddressPostalCode\": \"0510\",\n                \"postalAddressPostalPlace\": \"Oslo\",\n                \"countryCode\": \"NO\"\n            },\n            \"couponCode\": \"Datanews\",\n            \"couponNumber\": 1,\n            \"amount\": 100,\n            \"quantity\": 1,\n            \"phoneNumber\": \"+4712345678\",\n            \"email\": \"ola.nordmann@company.com\"\n        }\n    ]\n}"
Response samples 
application/json
{
  • "status": "ok"
}
➔ Next to RecruitmentCampaign