Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Preconstruction

Prequalification

10 endpoints10 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/prequalification/questionnairesList prequalification questionnaires available to a project
  2. POST /rest/v1.0/projects/{project_id}/prequalification/questionnairesCreate a prequalification questionnaire
  3. GET /rest/v1.0/projects/{project_id}/prequalification/questionnaires/{id}Show a prequalification questionnaire
  4. PATCH /rest/v1.0/projects/{project_id}/prequalification/questionnaires/{id}Update a prequalification questionnaire
  5. GET /rest/v1.0/projects/{project_id}/prequalification/submissionsList prequalification submissions on a project
  6. POST /rest/v1.0/projects/{project_id}/prequalification/submissionsInvite a vendor to prequalify (create submission)
  7. GET /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}Show a prequalification submission
  8. PATCH /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}Update a prequalification submission
  9. POST /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}/recordRecord received answers (staff action; local extension)
  10. POST /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}/reviewReview a submission (approve/reject with score)
GET /rest/v1.0/projects/{project_id}/prequalification/questionnaires

List prequalification questionnaires available to a project

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integer
  • project_id
    integer
  • questions
    object[]required
  • question_count
    integerrequired
  • reference_count
    integer
  • frozen
    boolean
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/prequalification/questionnaires

Create a prequalification questionnaire

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integer
  • project_id
    integer
  • questions
    object[]required
  • question_count
    integerrequired
  • reference_count
    integer
  • frozen
    boolean
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/prequalification/questionnaires/{id}

Show a prequalification questionnaire

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integer
  • project_id
    integer
  • questions
    object[]required
  • question_count
    integerrequired
  • reference_count
    integer
  • frozen
    boolean
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/prequalification/questionnaires/{id}

Update a prequalification questionnaire

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integer
  • project_id
    integer
  • questions
    object[]required
  • question_count
    integerrequired
  • reference_count
    integer
  • frozen
    boolean
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/prequalification/submissions

List prequalification submissions on a project

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • expired
    boolean
  • validity
    string
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/prequalification/submissions

Invite a vendor to prequalify (create submission)

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • expired
    boolean
  • validity
    string
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}

Show a prequalification submission

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • expired
    boolean
  • validity
    string
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}

Update a prequalification submission

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • expired
    boolean
  • validity
    string
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}/record

Record received answers (staff action; local extension)

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • prequal_submission
    objectrequired

Response · 200 · object

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/prequalification/submissions/{id}/review

Review a submission (approve/reject with score)

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • company_id
    integer
  • project_id
    integer
  • questionnaire_id
    integerrequired
  • questionnaire_name
    string
  • vendor
    objectrequired
  • status
    stringrequired
  • translated_status
    stringrequired
  • expired
    boolean
  • validity
    string
  • answers
    objectrequired
  • trade_scope
    string
  • bonding_capacity
    string
  • emr
    string
  • score
    integer
  • reviewed_by
    object
  • submitted_at
    string
  • expires_at
    string
  • created_at
    string
  • updated_at
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file