Skip to content

WS301 - Query protocol

Our service for request tracking

This integration aims to check the progress of a request.

Authentication

  • Calls will have transport-level authentication (Basic Authentication);
  • Request user / password from the account administrator.

Features

  • URL

    <https://entregas-api.comprovei.com/v1/protocols/<protocol>>

  • Method:

    GET

  • Success:

    • Code: 200
      Content:
Name Type Description
protocol Alphanumeric Protocol generated
requested_at Date and time Time the request was made
method Alphanumeric Method called
processed Numeric 0 – Processing has not yet started
1 – Processed
2 – In processing
success Numeric 0 – Failure
1 – Success
Blank - Pending
requested_data JSONObject Data sent in the request
response_data JSONObject Request response

  • Error:

    • Code: 404
      Content: 

          {
        "message" : "Protocolo não encontrado"
    }

    • Code: 400
      Content: 

          {
        "message" : "Protocolo inválido"
    }