sgrCancelaProgramacao
Cancel a system schedule.
PARAMETERS:
| Field | Type | Req. | Description |
|---|---|---|---|
| keyaccess | string | Yes | Key returned by the sgrLogin method. |
| cdpas | integer | Yes | PAS code, returned by the sgrListaPASUsuario method |
| cdcliente | integer | Yes | Customer code, returned by the sgrListaEmpresasPASUsuario method. |
| cdProgramacao | integer | Yes | Code of the schedule to be canceled |
| cdCancelReasonProg | integer | Yes | Cancellation reason code. This code is returned by the sgrListCancelReasonProg method. |
| dsCancelDetail | string | Yes | Details of the reason for canceling the schedule. |
| dsEmail | string | No | Single email or list of emails to which the schedule cancellation notification should be sent. |
METHOD RETURN:
If the parameters are correct, the webservice will cancel the schedule and send the Schedule Cancellation Notice to the e-mail address entered in the dsEmail parameter.
Possible errors:
| Error | Description |
|---|---|
| Cancellation reason does not exist for the client in the schedule. | The code entered for the cancellation reason was not found. The list of reasons is returned by the sgrListCancelReason method. |
| Error when canceling schedule. | The code entered in the cdprogramming parameter refers to a schedule that has already been canceled. You must check the code and try again. |
| Error when canceling schedule. | The code entered in the cdprogramming parameter refers to a schedule that has already been canceled. You need to check the code and try again. |
| Error canceling programming. Try again. |
Note: In the event of an error, the error message will be returned as a warning.