Data format
The assignment will be sent as a JSON to your specified end point
End point
[your endpoint]
Request format
POST
Request content
A HTTP Post containing a json with assignment data. Example
If using Basic authentication, the authentication header "Bearer" will contain the value entered in the "Client Secret" field
If using OAuth authentication, the authentication header "Bearer" will contain the received access token from the OAuth call.
| Property Name |
Type |
Description |
id |
|
Id of assignment in Brainville |
title |
|
Assignment title |
text |
|
Assignment text, including HTML formatting |
assignmentStart |
|
Date when assignment starts. Can be null, normally meaning that the assignment starts asap |
assignmentEnd |
|
Date when assignment ends. Can be null |
extent |
|
Json object:
{
"type": "[type id]",
"value": "[value]"
}
type - 1 (percentage), 2 (hours), 3 (hours per week) |
maxrate |
|
Json object:
{
"type": "[type id]",
"currency": "[currency]",
"priceAmount": "[amount]",
"display": "[displaytype]"
}
type - PerHour, PerDay, PerMonth, Fixed
currency - Standard currency codes (https://en.wikipedia.org/wiki/ISO_4217)
priceAmount - Decimal value
displayType - Mandatory, Negotiable, Informative |
roles |
|
List of job roles, as a json list of strings |
tags |
|
List of tags added to the assignment, as a json list of strings. Usually this lists connected skills.
|
locations |
|
List of locations. Each location is a json object:
{
"countryId": "[id]",
"regionId": "[id]",
"city": ["name"]
}
Id:s for countries/regions in Brainville can be found here: https://www.brainville.com/content/xml/countries.xml
|
level |
|
Level of experience needed for the assignment. Possible values:
Low
Medium
High
Advanced
Expert |
externalUrl |
|
A URL provided only when applications cannot be submitted through Brainville. If present, all applications must be made directly on the client’s own website. |
url |
|
URL to the assignment in Brainville |
allowRemote |
|
If the assignment allows for remote work
Possible values are "No", "Yes" and "Partly" |
referenceNumber |
|
Reference number of the assignment, if any |
acceptSubcontractors |
|
If the publishers of the assignment will allow applications from subcontractors. true/false-value |
externalId |
|
External Id from your system, set by previous export. Use this to decide if the assignment should be updated or created in your system |
accountEmail |
|
Account email in Brainville of the person doing the export |
created |
date |
|
updated |
date |
|
company |
string |
Name of publishing company |
optionDate |
date |
|
publicationEndDate |
date |
|
competenceAreaId |
integer |
|
Response Messages
If your endpoint successfully received and processed the json, you should return a HTTP message with HTTP Status 200, and a json body with the following structure:
{ "id": "[unique id from your system]" }
The id will be stored in Brainville, making it possible to update the same assignment on your end if exported again.
If not successful, you should return the appropriate HTTP error code