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

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

Payload
curl

application/json

{"product": "CO27409",
"campaign": "Spring2019",
"recruiter": {"name": {"firstName": "Kari",
"middleName": "Snøhaug",
"lastName": "Nordmann"
},
"address": {"streetAddress": "Osloveien",
"streetNumber": 12,
"entrance": "B",
"floor": 3,
"postalCode": "0101",
"postalPlace": "Oslo",
"postalAddress": "Postboks 6",
"postalAddressPostalCode": "0216",
"postalAddressPostalPlace": "Oslo",
"countryCode": "NO"
},
"phoneNumber": 4787654321,
"email": "kari.nordmann@gmail.com"
},
"recruitmentPremiumPreferences": [{"companyCode": "468979834",
"product": "HS3829",
"preferenceNumber": 1
}
],
"recruitments": [{"name": {"firstName": "Ola",
"middleName": "Fjordstrand",
"lastName": "Nordmann",
"companyName": "Company International Ltd",
"departmentName": "Support"
},
"address": {"streetAddress": "Grubbegata",
"streetNumber": 6,
"entrance": "A",
"floor": 6,
"postalCode": 179,
"postalPlace": "Oslo",
"postalAddress": "Postboks 265 Økern",
"postalAddressPostalCode": "0510",
"postalAddressPostalPlace": "Oslo",
"countryCode": "NO"
},
"couponCode": "WMDigi",
"couponNumber": 5223,
"amount": 1,
"quantity": 1,
"phoneNumber": 4712345678,
"email": "ola.nordmann@company.com"
}
]
}

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

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

curl

Response samples

application/json

{"points": 50,
"products": ["CO27409"
],
"recruitments": [{"recruited": 1,
"product": "CO27409",
"active": true,
"recruitedDate": 1560524119000,
"points": 42
}
],
"unverifiedRecruitments": [{"product": "29452",
"recruitedDate": 1550678119000,
"status": "Ubehandlet",
"points": 34
}
]
}

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

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

curl

Response samples

application/json

{"recruitmentPremiumPreferences": [{"companyCode": "468979834",
"product": "HS3829",
"preferenceNumber": 3
}
]
}

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

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

Payload
curl

application/json

{"recruitmentPremiumPreferences": {"companyCode": "468979834",
"product": "HS3829",
"preferenceNumber": 3
}
}

Response samples

application/json

{"recruitmentPremiumPreferences": [{"companyCode": "468979834",
"product": "HS3829",
"preferenceNumber": 3
}
]
}

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

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

Payload
curl

application/json

{"product": "CO27409",
"campaign": "Spring2019",
"recruiter": {"name": {"firstName": "Kari",
"middleName": "Snøhaug",
"lastName": "Nordmann"
},
"address": {"streetAddress": "Osloveien",
"streetNumber": 12,
"entrance": "B",
"floor": 3,
"postalCode": "0101",
"postalPlace": "Oslo",
"postalAddress": "Postboks 6",
"postalAddressPostalCode": "0216",
"postalAddressPostalPlace": "Oslo",
"countryCode": "NO"
},
"phoneNumber": 4787654321,
"email": "kari.nordmann@gmail.com"
},
"recruitmentPremiumPreferences": [{"companyCode": "468979834",
"product": "HS3829",
"preferenceNumber": 1
}
],
"recruitments": [{"name": {"firstName": "Ola",
"middleName": "Fjordstrand",
"lastName": "Nordmann",
"companyName": "Company International Ltd",
"departmentName": "Support"
},
"address": {"streetAddress": "Grubbegata",
"streetNumber": 6,
"entrance": "A",
"floor": 6,
"postalCode": 179,
"postalPlace": "Oslo",
"postalAddress": "Postboks 265 Økern",
"postalAddressPostalCode": "0510",
"postalAddressPostalPlace": "Oslo",
"countryCode": "NO"
},
"couponCode": "Datanews",
"couponNumber": 1,
"amount": 100,
"quantity": 1,
"phoneNumber": 4712345678,
"email": "ola.nordmann@company.com"
}
]
}

Response samples

application/json

{"status": "ok"
}

➔ Next to RecruitmentCampaign