sgrListaAE
Returns a list of Shipment Authorizations by date, recipient, type of operation, city of destination or origin, estimated time of arrival, carrier.
PARAMETERS
| Field | Type | Req.? | Description |
|---|---|---|---|
| accesskey | string | Yes | Key returned by the sgrLogin method. |
| cdpas | integer | Yes | PAS code, returned by the sgrListaPASUsuario method |
| cdcliente | integer | Yes | Client code, returned by the sgrListaEmpresasPASUsuario method. |
| initialDate | datetime | Yes | Start date for the search. |
| finalDate | datetime | Yes | End date for the search. |
| type | integer | Yes | Enter 1 for the expected date, and 2 for the actual date. |
| plate | string | No | Vehicle license plate number. |
| cdDest | integer | No | Recipient code, returned by the sgrListaDestinatarios method. |
| tipoOperacao | integer | No | Operation type code. This code is returned by the sgrListaTiposOperacao method. |
| cdCidOrig | integer | No | Origin city code, returned by the sgrListaCidades method. |
| cdCidDest | integer | No | Destination city code, returned by the sgrListaCidades method. |
| dtPrevisaoChegada | string | No | Estimated arrival date. Send in “YYYY-MM-DD” format. |
| cdTransp | integer | No | Transport company code. This code is returned by the sgrListaTransportadoras method. |
METHOD RETURN:
ReturnDataset: If the parameters are valid, the dataset will display:
| Field | Type | Description |
|---|---|---|
| CDVIAG | integer | Boarding authorization number |
| NRPLACACARRETA | char(7) | Truck plate |
| DESTINATARIO | string | Recipient |
| DTPREVINI | datetime | Estimated start date of the trip |
| DTPREVFIM | datetime | Estimated end date of the trip |
| DTINI | datetime | Start date of the trip |
| DTFIM | datetime | End date of the trip |
| DSCIDORIGEM | string | Name of the city of origin |
| ESTADOORI | char(2) | State of origin (acronym) |
| DSCIDDESTINO | string | Name of the city of destination |
| ESTADODES | char(2) | State of destination (acronym) |
| NRCONTROLECARGA | string | Field for free use by the customer (20 characters). |
| FLSITUACAO | smallint | Trip status (code) |
| SITUACAO | string | Description of the trip status |
| NRCPFMOT1 | char(11) | Driver's CPF |
| MOTORISTA1 | string | Driver's name |
| CDOPEMISSOR | integer | AE issuing user code |
| OPEMISSOR | char(10) | AE issuing user |
| CDCIDORIG | integer | Origin city code |
| CDCIDDEST | integer | Destination city code |
| CDTRANSP | integer | Transport company code |
| CDPROD | integer | Shipping authorization product code |
| DTPREVISTA | datetime | Estimated arrival date |
| DTINCL | datetime | AE inclusion date |
ReturnDescription: If there is an error executing the method, the property will display:
| Error | Description |
|---|---|
| Invalid type! | Must be '1' to list by estimated start date or '2' for actual start date. |
| There are no Authorizations for the period entered! |