WS323 - Document scheduling

WS323 - Our document scheduling service

This integration aims to open a request to schedule documents.

Click here to see version history

Update date	Service publication date	Changes
05/06/2021	05/12/2021	Availability of the webservice for approval
05/06/2021	05/17/2021	Availability of the webservice for production
07/20/2021	07/20/2021	Availability of the "code" field for the service

Authentication

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

Features

• URL

  <https://entregas-api.comprovei.com/v1/documents/scheduling>

• Method:

  POST

This integration returns a protocol for monitoring - WS301

Parameters

Example

[{
    "key" : "41190943434343434343550020003567351594519865",
    "date" : "2021-05-06",
    "annotation" : "Cliente solicitou a entrega nesta data",
    "code" : "997"
}]

Property	Type	Description
key	Alphanumeric	Access key for the document that will be scheduled (required)
date	Alphanumeric	Date the document is scheduled in the format "YYYY-MM-DD" (required)*
annotation	Alphanumeric	Note regarding scheduling (optional)
code	Alphanumeric	Event code (optional*): * 997 - Scheduling * 993 - "Scheduled" or "Attempted to schedule" (According to account configuration)

*

• If the "code" field is not sent, the system will understand that an appointment has been made.
  It can be sent in the format "YYYY-MM-DD HH:MM:ss".

• Success:

  • Code: 202
    Content:

    {
        "message" : "OK",
        "protocol" : "<protocol>"
    }
    

    {
        "message" : "Algumas notas enviadas apresentaram erros. Consulte o protocolo para detalhes",
        "protocol" : "<protocol>" 
    
    }
    

• Error:

  • Code: 400
    Content:

    {
        "message": "Corpo da requisição deve ser um array"
    }
    

    {
        "message" : "Corpo da requisição não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, elemento deve ser um objeto json válido" 
    }
    

    {
        "message" : "Na posição p, elemento não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'key' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'key' não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'annotation' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'annotation' não pode estar vazio" 
    }
    

    {
        "message" : "Na posição p, campo 'date' deve ser alfanumérico" 
    }
    

    {
        "message" : "Na posição p, campo 'date' não pode estar vazio" 
    }