Search for checklist status
    • PDF

    Search for checklist status

    • PDF

    Article summary

    Overview

    • Search for the last check time of the checklist and check the availability of check requests.
    • Each checklist has its own status (check request status).
      • status changes internally over the progress of the check request or over time, and has one of the following five values:
        • NONE: A check may be requested.
        • ENQUEUED: Waiting for a check.
        • PROCESSING: Check in progress.
        • DONE: Check request completed. Need to wait until the next request.
        • FAIL: Check failed.

    API

    • GET /categories/{categoryCode}/checkitems/status
      • Check the availability of check requests for all checklists corresponding to {categoryCode}.
    • GET /categories/{categoryCode}/checkitems/{itemCode}/status
      • Check the availability of check requests for one checklist corresponding to {itemCode}.
      • 404 error also occurs when a request is made by entering {itemCode} that is not included in the input {categoryCode}.

    Requests

    Headers

    You need a common request header specified in the overview.

    Path Variables

    Parameter nameRequirement statusTypeRestrictionsDescription
    categoryCodeNStringPlease see the Category offering and checklist.Category code
    itemCodeNStringPlease see the Category offering and checklist.Checklist code

    Responses

    Response Body

    {
      "result": "SUCCESS",
      "contents": [
        {
          "itemCode": String,
          "timeToRefresh": Timestamp,
          "lastRequestTime": Timestamp,
          "status": String,
          "refreshable": Boolean
        },
        ...
      ]
    }
    
    Response field nameRequirement statusTypeRestrictionsDescription
    itemCodeYStringChecklist code
    timeToRefreshYTimestampNext time available for check
    lastRequestTimeYTimestampLast check time
    statusYStringNONE, ENQUEUED, PROCESSING, DONE, FAILLast check status
    NONE: A check may be requested.
    ENQUEUED: Waiting for a check
    PROCESSING: Check in progress
    DONE: Check request completed. Need to wait until the next request.
    FAIL: Request failed.
    refreshableYBooleantrue, falseCheck request availability

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.