The pay/getStatusReport method is an Elance Developer API Pay method that returns a specific status report, along with all associated work items. Each work item represents a.

pay/getStatusReport is an authenticated method. It requires a Developer API key and an OAuth Consumer Secret, both issued by Elance. It is invoked using an HTTP or HTTPS GET request. For more details on the OAuth authentication protocol, see Using OAuth with Authenticated Methods.

This method does not support the JSONP response format.

For more information on the format of an Elance Developer API request, see Getting Started.

I. Optional Query String Parameters

Parameter Description
id integer Required if bidId is not present; otherwise, optional. The unique ID of the status report to retrieve.
bidId integer Required if is not present; otherwise, optional. The Workroom from which the status report is retrieved. If id is not present, the method returns the current week's status report.

II. Response Data Description

Property Data Type Description
bidDetails BidData object The details regarding this bid and associated Workroom, including project name, client, and provider.
statusReport TimesheetData object The status report requested with the id parameter. If the bidId parameter was used without the id parameter, this will be the most recent status report for the awarded project.
comments array of StatusReportCommentData objects
workItems array of WorkItemData objects The logged hours for this project.
progressItems array of ProgressItemData objects The progress updates reported for this status report. Includes percentage complete, amount paid (if applicable), and a pointer to the associated invoice (if applicable).

III. Request/Response Examples in JSON

1. Retrieving The Most Recent Status Report

The following HTTP GET request demonstrates retrieving the most recent status report for an awarded project using the bidId parameter. The HTTP headers for the GET request are shown below. (NOTE: Elance recommends that developers access OAuth APIs using one of the many publicly available libraries.)

A. Request

GET /api/pay/getStatusReport?bidId=21011223 HTTP/1.1
User-Agent: anyMeta/OAuth 1.0 - ($LastChangedRevision: 134 $)
Host: api.elance.com
Accept: */*
Authorization: OAuth realm="",oauth_signature_method="HMAC-SHA1",oauth_signature="YHpUKkLbUI6B%2B%2BUwY54rFpml2wk%3D",oauth_nonce="4c8bba92d8a91",oauth_timestamp="1284225682",oauth_token="988078256-1425962-1425962-76.99.193-fd76b324028bef6-%2B",oauth_consumer_key="8cfc475b57fee5b7dc08cc0f1d5a0fcdab409b3c",oauth_version="1.0"

B. Response

{
    "api" : "pay\/getStatusReport",
    "apiVersion" : 1,
    "rcode" : 1,
    "data" :  {
        "bidDetails" :  {
            "bidId" : "21011223",
            "jobId" : "24168926",
            "jobName" : "Fixed Project Job",
            "userType" : "PROVIDER",
            "clientUserId" : "2022964",
            "clientName" : "enzodesigns",
            "clientImageURL" : "https:\/\/www.elance.com\/file\/SG_logo100x100.jpg?crypted=Y3R4JTNEc2VhcmNoX3RodW1ibmFpbCUyNmZpZCUzRDIwMzEwMTczJTI2cmlkJTNELTElMjZwaWQlM0QxOTY5MjI4",
            "clientCountry" : "United States",
            "clientCountryCode" : "US",
            "clientCity" : "Honolulu",
            "providerUserId" : "1976925",
            "providerName" : "John Smith",
            "providerImageURL" : "https:\/\/navws.elance.com\/file\/luffy.jpg?crypted=Y3R4JTNEc2VhcmNoX3RodW1ibmFpbCUyNmZpZCUzRDI0NTA5NjA2JTI2cmlkJTNELTElMjZwaWQlM0QxOTc2OTI1",
            "providerCountry" : "United States",
            "providerCountryCode" : "US",
            "providerCity" : "Mountain View",
            "phase" : "5",
            "status" : "Working",
            "secondaryStatus" : "",
            "isHourly" : false,
            "isSponsored" : false,
            "isPreBid" : false,
            "bidAmount" : "123",
            "duration" : "",
            "submissionDate" : 1306209600
        } ,
        "statusReport" :  {
            "id" : 0,
            "week" : "29-MAY-11",
            "bidId" : 24168926,
            "client" : "enzodesigns",
            "provider" : "johnsmith",
            "clientUserId" : 2022964,
            "providerUserId" : 1976925,
            "status" : "Draft",
            "projectStatus" : "OK",
            "projectStatusChangedBy" : "PROVIDER",
            "planComment" : "",
            "startDate" : 1306123200,
            "endDate" : 1306641600,
            "nextEndDate" : 1307246400,
            "totalHours" : 0,
            "overdue" : false,
            "seenByClient" : false,
            "invoiceIds" : []
        } ,
        "comments" :  {
        } ,
        "workItems" :  {
            "0" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306123200,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "1" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306209600,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "2" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306296000,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "3" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306382400,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "4" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306468800,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "5" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306555200,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "6" :  {
                "parentId" : 0,
                "workUnitId" : 1,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306641600,
                "type" : "Hourly Milestone",
                "status" : "Draft",
                "description" : "Final Deliverable",
                "quantity" : 0,
                "milestoneId" : 3750858
            } ,
            "7" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306123200,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "8" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306209600,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "9" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306296000,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "10" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306382400,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "11" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306468800,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "12" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306555200,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            } ,
            "13" :  {
                "parentId" : 0,
                "workUnitId" : 2,
                "userId" : 2022964,
                "userName" : "johnsmithinc",
                "displayName" : "John Smith",
                "day" : 1306641600,
                "type" : "Hourly Other",
                "status" : "Draft",
                "description" : "",
                "quantity" : 0,
                "milestoneId" : 0
            }
        } ,
        "progressItems" :  {
            "0" :  {
                "parentId" : 0,
                "description" : "Final Deliverable",
                "milestoneId" : 3750858,
                "targetCompletionDate" : 1307419200,
                "deliveryDate" : 1307419200,
                "revised" : false,
                "progressPercent" : 0,
                "amount" : 123,
                "paidDate" : 0
            }
        }
    }
}

IV. Error Codes

Error Code Description
E_VALIDATION_INVALID_ID_BIDID The request is missing both an id parameter and a bidId parameter; at least one of these two parameters is required for the request to succeed.
E_VALIDATION_INVALID_ID The id or bidId parameter is invalid; or, the parameter is valid, but the current user does not have permission to access the associated object.

For a list of other common errors that can be thrown by this method, see Common API Error Codes.