Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/file/flag/items

This action lists all bids and PCR questions in the work order to which files can be flagged.

Request

FieldDescriptionRequired
report_idUnique identifier for the work orderYes

Example:

{
  "report_id": 3660
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"report_id": 3660}' \
     https://ppw.web/svc/file/flage/items

Response

FieldDescriptionType
itemsItems in the work order photos can be flagged toobject

The items JSON object can contain three fields — bids, completions, and pcr. The bids and completions fields lists bid/completion items, each bid/completion item is uniquely identified by the comp_note_id. The pcr field lists PCR questions, each PCR question is uniquely identified by the pcr_question_id.

Example successful response:

{
  "items": {
    "bids": [{
      "comp_note_id": 60,
      "description": "Locks"
    }],
    "pcr": [{
      "form": "1- Exterior Inspection",
      "question": "Why can't you complete the exterior inspection? (Check all that apply)",
      "pcr_question_id": 3802
    }, {
      "form": "1- Exterior Inspection",
      "question": "Occupant type",
      "pcr_question_id": 3810
    }],
    "completions": [{
        "comp_note_id": 85,
        "description": "Debris Exterior"
      },
      {
        "comp_note_id": 86,
        "description": "Winterization (Dry)"
      }
    ]
  }
}

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403
invalid_woThe report_id in the request is invalid400