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 |
integer |
Id of assignment in Brainville |
title |
string |
Assignment title |
text |
string |
Assignment text, including HTML formatting |
assignmentStartDate |
date |
Date when assignment starts. Can be null, normally meaning that the assignment starts asap |
assignmentEndDate |
date |
Date when assignment ends. Can be null |
extent |
custom |
Json object:
{
"type": "[type id]",
"value": "[value]"
}
type - 1 (percentage), 2 (hours), 3 (hours per week) |
maxrate |
custom |
Json object:
{
"type": "[type]",
"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
string |
List of job roles, as a json list of strings |
tags |
List of
string |
List of tags added to the assignment, as a json list of strings. Usually this lists connected skills.
|
locations |
custom |
List of locations. Each location is a json object:
{
"countryId": "[id]",
"regionId": "[id]",
"city": "[name]",
"country": "[name]",
"region": "[name]"
}
Id:s for countries/regions in Brainville can be found here: https://www.brainville.com/content/xml/countries.xml
|
level |
string |
Level of experience needed for the assignment. Possible values:
Low
Medium
High
Advanced
Expert |
url |
string |
URL to the assignment in Brainville |
allowRemote |
string |
If the assignment allows for remote work
Possible values are "No", "Yes" and "Partly" |
referenceNumber |
string |
Reference number of the assignment, if any |
acceptSubcontractors |
boolean |
If the publishers of the assignment will allow applications from subcontractors. true/false-value |
accountEmail |
string |
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 |
|
category |
string |
Type of assignment |
endClientStatus |
string |
If the assignment has an end client specified
NotSet = Not specified
False = Assignment has no end client
True = Assignment has an end client separate from publishing company
Owner = End client is publishing company |
endClientName |
string |
If endClientStatus has value "True", this will contain the name of the end client |
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