The workroom/{bidId}/contractors method requests a list of the contractors who are assigned to a project. It obsoletes the manage/getMyProviders method in Version 1 of the Elance Developer API.

If a Workroom contains more than 20 contractors, the results will be returned in pages, and obtaining the full data set will require multiple requests. Pages default to containing 20 records per page. Client applications can use the rpp query string parameter to increase or decrease the number of records per page. By default, the first page of results is returned with an initial request; additional pages are requested by issuing subsequent requests on the same search with the page query string parameter.

This method must be called using an HTTPS GET request. All responses are returned in the JSON format.

tableofcontents_number_textPreconditions

This method requires that the calling application has authenticated a user with the OAuth 2.0 protocol, as described on the Getting Started page.

tableofcontents_number_textRequired URL Parameters

Parameter Description
bidId The unique ID assigned by Elance to the Workroom.

tableofcontents_number_textOptional Query String Parameters

Parameter Description
page The page number of results to return, numbered beginning from 1. The default is 1. If this number is greater than the number of total pages (as expressed in the response by totalPages), the response contains zero results.
rpp The number of results requested per page. The default is 20. If more than 25 are requested, only 25 results are included in the response.

tableofcontents_number_textResponse Data Description

Property Name Data Type Description
totalResults integer The number of AgentInformation objects available for this Workroom, across all pages.
totalPages integer The total number of pages of data available.
page integer The page number for this request.
numResults integer The total number of AgentInformation objects returned in this request.
agents Agent hash array A hash consisting of both a set of named property, defined below in Agent Array Data Description, as well as a list of AgentInformation objects, indexed numerically starting from 0.
bidData BidData object Information on the associated Workroom identified by the bidId parameter.

tableofcontents_number_textAgent Array Data Description

Property Name Data Type Description
"0"..."n" AgentInformation object An array of AgentInformation objects, indexed beginning from 0, that enumerate the contractors associated with the Workroom. The total number of AgentInformation objects is one less than the value of the numResults property. Note that the are text (hash) labels, and not numeric indices. 

tableofcontents_number_textAgentInformation Object Data Description

Property Name Data Type Description
screenData ScreenData object An object containing properties that describe display data associated with the contractor. See below for a description of the properties associated with the ScreenData object.
isOnTracker boolean True if the contractor is using Tracker to capture his or her work hours on an hourly project; otherwise, false. (This property will always be false for fixed price projects.)
hours integer The total number of hours worked on this project by this contactor for the week.
hoursToday integer The total number of hours this contractor has devoted to this project for the current day.

tableofcontents_number_textScreenData Object Data Description

Property Name Data Type Description
timestamp timestamp ???
userId integer The unique ID assigned by Elance to the contractor on the Elance system.
userName string The display name of the contractor, as chosen by the user.
companyName string The name of the contractor's corporate identity or employer.
logoURL string A pointer to the graphic representing the contractor, such as a photo or a company logo.
numComments integer
bidId integer The unique ID, assigned by Elance, associated with this bid. This ID is also the unique ID of the project's Workroom, which is created for each proposal as soon as a proposal is submitted.
bidCount integer The number of bids this contractor has placed on this project.
bidData BidData object Information on the associated Workroom identified by the bidId parameter.
date Date
displayTime string The current time as it is shown to the contractor on Elance.
screenIdx integer

tableofcontents_number_textBidData Object Data Description

Property Name Data Type Description
bidId integer The unique ID, assigned by Elance, associated with this bid. This ID is also the unique ID of the project's Workroom, which is created for each proposal as soon as a proposal is submitted.
jobId integer The unique ID of the associated job to which this Workroom is attached.
jobName string The name of the associated job, as chosen by the employer when the job was posted.
userType string Specifies the role occupied by the currently logged in user in this project.
clientUserId integer The unique integer ID assigned to the employer on Elance.
clientUserName string The unique text string chosen by the employer as her Elance login.
clientName string The individual or corporate name of the employer.
clientImageURL string The URL resource pointer to the picture representing the employer, such as a photograph or a logo.
clientCountry string The employer's country, returned as the full name of the nation.
clientCountryCode string The alpha-2 country code for the employer's country of residence, as specified by ISO 3166-1.
providerUserId integer The unique ID of the contractor, as assigned by Elance.
providerName string The legal name of the contractor.
providerCompany string The name of the contractor's business. If the contractor is a sole proprietor, this name will be equal to the value of the providerName property.
providerCompanyURL string The URL to the Web site of the contractor's business.
providerImageURL string The URL resource pointer to the picture representing the contractor, such as a photograph or a business logo.
providerProfileURL string The URL to the contractor's Elance profile.
providerJobHistoryURL string A URL linking to a page on Elance.com that displays the recent Elance jobs worked by the contractor.
providerImageURL string The URL resource pointer to the picture representing the contractor, such as a photograph or a business logo.
providerCountry string The contractor's country, returned as the full name of the nation.
providerCountryCode string The alpha-2 country code for the contractor's country of residence, as specified by ISO 3166-1.
providerCity string The contractor's city of residence.
providerState string The contractor's state or province of residence.
providerRegion string Region where the contractor resides. For example: North America or Europe.
providerHourlyRate string The average amount that the contractor charges on an hourly basis.
providerIdVerified boolean True if the contractor has verified her identity using Elance's identity verification service; otherwise, false.
providerIsBusiness boolean True if the contractor is a legal business entity; otherwise, false.
phase integer (Enumeration) A value indicating the current state of the project, such as whether it is open, in progress, or complete. See Phase Enumeration for valid values.
status string A textual representation of the current phase of the project. Used for display purposes only; the values returned for this property may change without notice.
secondaryStatus string A textual representation of the current phase of the project.
isHourly boolean True if the contractor charges the employer for every hour worked; false if the job is fixed price, and paid according to the fulfillment of milestones agreed upon by the employer and the contractor.
isSponsored boolean True if the contractor paid additional Connect points to promote this bid in the bid listings; otherwise, false.
isDelisted boolean True if this bid has been removed due to a violation of Elance policies; otherwise, false.
isPreBid boolean True if the bid represents a question from the contractor to the employer, and does not include a price quote; otherwise, false.
isAwarded boolean True if this bid was selected as the winning bid for the associated job; otherwise, false.
isCompleted boolean True if the associated project has been marked by both the employer and the contractor as finished; otherwise, false.
bidAmount decimal (JSON string) The total amount, in US dollars, that the contractor is proposing as the project cost.
hourlyRate decimal (JSON string) The amount per hour that the contractor proposes charging for this work. If the job is a fixed-price job, this property will be an empty string.
hoursPerWeek integer (JSON string) The number of hours the contractor proposes working each week until project completion.
duration integer The proposed time it will take to complete the project. This unit is either days, weeks, or months, and depends upon the desired timeframe initially selected by the employer.
submissionDate timestamp The time, expressed in seconds elapsed since January 1st, 1970, on which this proposal was submitted by the contractor to the employer.
awardedDate timestamp The time, expressed in seconds elapsed since January 1st, 1970, on which the employer selected this proposal as the winning bid.
contractEndDate string The day by which the contract should be completed. For hourly projects, this marks the final day on which billed hours will be auto-approved.
milestonesCount integer The number of status checkpoints associated with this project.
milestonesCompleted integer The number of project status checkpoints that have elapsed as of the current day.
deliveryCode integer (JSON string)

tableofcontents_number_textRequest/Response Examples in JSON

tableofcontents_number_textRequesting a List of Contractors

The following HTTP GET command requests a list of all of the contractors associated with the project whose Workroom ID (bidId) is 27614904.

tableofcontents_number_textRequest

 

tableofcontents_number_textResponse

{
   "api":"workroom/30561769/contractors",
   "rcode":1,
   "data":{
      "totalResults":1,
      "totalPages":1,
      "page":1,
      "numResults":1,
      "agents":{
         "0":{
            "screenData":{
               "timestamp":1337661458,
               "userId":"4124672",
               "userName":"Ted M.",
               "companyName":"Ted Mosby",
               "logoURL":"https://elance.com/media/images/4.0/no-photo-64x80.jpg",
               "numComments":0,
               "bidCount":"1",
               "bidId":"30561769",
               "bidData":{
                  "bidId":"30561769",
                  "jobId":"30561768",
                  "jobName":"PHP Development Required ASAP",
                  "userType":"PROVIDER",
                  "clientUserId":"4124673",
                  "clientUserName":"m_eriksen",
                  "clientName":"m_eriksen",
                  "clientImageURL":"https://elance.com/media/images/4.0/no-photo-64x80.jpg",
                  "clientCountry":"United States",
                  "clientCountryCode":"US",
                  "providerUserId":"4124672",
                  "providerUserName":"t_mosby",
                  "providerName":"Ted Mosby",
                  "providerCompany":"Ted Mosby",
                  "providerCompanyURL":"https://elance.com/s/t_mosby/",
                  "providerImageURL":"https://elance.com/media/images/4.0/no-photo-64x80.jpg",
                  "providerProfileURL":"https://elance.com/s/t_mosby/",
                  "providerJobHistoryURL":"https://elance.com/s/t_mosby/job-history/",
                  "providerCountry":"United States",
                  "providerCountryCode":"US",
                  "providerCity":"Seattle",
                  "providerState":"WA",
                  "providerRegion":"021",
                  "providerHourlyRate":"33",
                  "providerIdVerified":false,
                  "providerIsBusiness":false,
                  "phase":"5",
                  "status":"Working",
                  "secondaryStatus":"",
                  "isHourly":false,
                  "isSponsored":false,
                  "isDelisted":false,
                  "isPreBid":false,
                  "isAwarded":true,
                  "isCompleted":true,
                  "bidAmount":"2191.78",
                  "hourlyRate":"0",
                  "hoursPerWeek":"0",
                  "duration":"",
                  "submissionDate":1337659200,
                  "awardedDate":1337659200,
                  "contractEndDate":"Jul 22, 2012",
                  "milestonesCount":1,
                  "milestonesCompleted":0,
                  "deliveryCodeId":"13012"
               },
               "date":"22-MAY-12",
               "displayTime":"12:37 am",
               "screenIdx":3
            },
            "isOnTracker":false,
            "hours":0,
            "hoursToday":0
         }
      },
      "showFilters":{
         "filter_jobs":false,
         "filter_status":true
      },
      "bidData":{
         "bidId":"30561769",
         "jobId":"30561768",
         "jobName":"PHP Development Required ASAP",
         "userType":"PROVIDER",
         "clientUserId":"4124673",
         "clientUserName":"m_eriksen",
         "clientName":"m_eriksen",
         "clientImageURL":"https://elance.com/media/images/4.0/no-photo-64x80.jpg",
         "clientCountry":"United States",
         "clientCountryCode":"US",
         "providerUserId":"4124672",
         "providerUserName":"t_mosby",
         "providerName":"Ted Mosby",
         "providerCompany":"Ted Mosby",
         "providerCompanyURL":"https://elance.com/s/t_mosby/",
         "providerImageURL":"https://elance.com/media/images/4.0/no-photo-64x80.jpg",
         "providerProfileURL":"https://elance.com/s/t_mosby/",
         "providerJobHistoryURL":"https://elance.com/s/t_mosby/job-history/",
         "providerCountry":"United States",
         "providerCountryCode":"US",
         "providerCity":"Seattle",
         "providerState":"WA",
         "providerRegion":"021",
         "providerHourlyRate":"33",
         "providerIdVerified":false,
         "providerIsBusiness":false,
         "phase":"5",
         "status":"Working",
         "secondaryStatus":"",
         "isHourly":false,
         "isSponsored":false,
         "isDelisted":false,
         "isPreBid":false,
         "isAwarded":true,
         "isCompleted":true,
         "bidAmount":"2191.78",
         "hourlyRate":"0",
         "hoursPerWeek":"0",
         "duration":"",
         "submissionDate":1337659200,
         "awardedDate":1337659200,
         "contractEndDate":"Jul 22, 2012",
         "milestonesCount":1,
         "milestonesCompleted":0,
         "deliveryCodeId":"13012"
      }
   }
}

tableofcontents_number_textError Codes

Error Description
E_WORKROOM_INVALID_BID Either the bidId supplied in the URL is invalid, or the currently logged in user does not have permission to access that Workroom.

For a list of additional error codes that can be thrown by this method, see Common API Error Codes.