Create
How to post a new assignment to the Brainville Marketplace.
Note: in this document the word assignment refers to a job posting on the Brainville
Marketplace.
End point
/api/DistributionApi/Create
Request format
POST
Request content
The request body should be formatted as XML, see below.
<?xml version=""1.0"" encoding=""UTF-8""?>
<requisition>
<assignmentstartdate></assignmentstartdate>
<assignmentenddate></assignmentenddate>
<competenceareaid></competenceareaid>
<extent></extent>
<extenttype></extenttype>
<location></location>
<locationcountryid></locationcountryid>
<masterlevel></masterlevel>
<maxrate></maxrate>
<maxratedisplay></maxratedisplay>
<publicationenddate></publicationenddate>
<regionid></regionid>
<role></role>
<text></text>
<title></title>
<applicationemail></applicationemail>
</requisition>
Property Name |
Required |
Description |
acceptsubcontractors |
No |
Boolean value (true/false)
If subcontractors are accepted when applying for this assignment |
allowremote |
No |
Boolean value (true/false) or"No", "Yes", "Partly" If the assignment allows for remote work |
applicationemail |
No |
Tracking email from calling system |
assignmentenddate |
No |
End date for the assignment. If specified, should be formatted as YYYY-MM-DD |
assignmentstartdate |
No |
Start date for the assignment. If specified, should be formatted as YYYY-MM-DD |
autotags |
No |
Boolean value (true/false)
Tags the assignment automatically. This property is ignored if tags have been explicitly set by the request
Default value: true |
category |
No |
Assignment category. Possible values:
0 - Consultant (default)
1 - Commitment
2 - Licenses/software
3 - Hardware |
competenceareaid |
Yes |
An integer value for competence area (industry). Possible values can be found here:
https://www.brainville.com/content/xml/industries.xml |
endclient |
No |
End client status. Possible values:
0 (default) - Not set
2 - Posting company have agreement with the end client
3 - Posting company is the end client |
endclientvat |
No |
Vat ID for end client (if any). Note that Brainville will automatically try to create the end client if the VAT doesn't belong to an existing client |
extent |
Yes |
Extent in hours or percentage. Must be an integer. Extent is the total number of hours or a percentage of a full time that the consultant is expected to work with the assignment. |
extenttype |
Yes |
Integer value:
1 - Percentage 2 - Hours 3 - Hours per week |
externalurl |
No |
URL to external site. Displayed as a link on top of an assignment in Brainville, if applicable and according to agreement.
This parameter is deprecated. |
locations |
No |
List of locations for the assignment
Format:
<locations> <location> <city></city> <regionid><regionid> <countryid></countryid> <location> </locations>
Possible values for countryid and regionid can be found here: https://www.brainville.com/content/xml/countries.xml
|
location |
Yes |
Geographic location, i.e. city name
NOTE: Deprecated. Please use the locations property instead |
locationcountryid |
Yes |
Country id. Possible values can be found here:
https://www.brainville.com/content/xml/countries.xml
NOTE: Deprecated. Please use the locations property instead |
masterlevel |
Yes |
Skill/Experience level. Possible values are
Low Medium High Advanced Expert |
maxrate |
No |
Rate, if specified must be a numeric value. Decimal values are allowed. |
maxratedisplay |
No |
How maxrate should be displayed. Possible values:
1 - Mandatory
2 (default) - Informative
4 - Negotiable (rate is not shown) |
nodelay |
No |
Boolean value (true/false) Publishes the assignment directly to non-premium users of Brainville (without the normal delay of 48 hours). Note that in most cases the publishing company will be charged for each assignment published with NoDelay.
Nodelay can only be used if your company has been approved for this. For more information, contact us at support@brainville.com
|
optiondate |
No |
If there's an option to extend, specifies the end date of the potential extension. If assignmentenddate is specified, optiondate must be greater than that value. |
publicationenddate |
Yes |
End date for assignment publication. Must be a date on the format YYYY-MM-DD hh:mm:ss or YYYY-MM-DD. Note: The date has to be in the future! |
referencenumber |
No |
Internal reference number used by posting company |
regionid |
No |
Region ID. Possible values can be found here: https://www.brainville.com/content/xml/countries.xml Note that regions belong to countries. Which regions belong to which countries can be found in the above xml.
NOTE: Deprecated. Please use the locations property instead |
requestor |
No |
Id-number för the Co-worker that will be shown as Contact for the assignment. This Id can be found as the last numeric part of the URL when clicking on a Co-worker in Brainville. If not specified, the user identified by the authkey will be set as requestor. |
role |
Yes |
Consultant role for the assignment. Must be a text containing max 100 characters. |
tags |
No |
List of tags for the assignment. Format:
<tags> <tag>Java</tag> <tag>JBoss</tag> </tags> |
text |
Yes |
Description of assignment. Must be a text containing max 10 000 characters. HTML-formatting can be used, but is limited to the following tags:
br i b li ul
Observe that if you send HTML-tags as part of the text, these have to be XML-encoded, or sent as part of a CDATA-element. |
title |
Yes |
Title of the assignment. Must be a text containing max 100 characters. |
Response Messages
The Brainville API will respond to the HTTP POST in the following manner:
Success
If the post was successful, the response will be the URL to the posted assignment. For example: https://www.brainville.com/Market/RequisitionSearchResult/Details/6020
Failure
Bad XML – If the XML is malformed, a HTTP Status 400 (Bad Request) will be returned.
Missing/incorrect data – If the XML is correct, but the data inside it is wrong (for example, a required value is missing, out of range or of the wrong type), a message with HTTP Status 200 (OK) will be returned. The message will begin with “ERROR:”, then followed by a text describing the specific error.