Skip to main content

Starting Instructions

First of all, it is necessary to understand some concepts that will be seen frequently in this manual, as follows.

Advanced Service Station (PAS):

Each system user can be linked to one or more PAS's, as required. A PAS is also linked to one or more clients, as required. A company can use a PAS for each branch, or operate with just one PAS that covers all its customers. However, the user can only generate an AE for a customer who is linked to the selected PAS.

Ex: A user carries out operations for a shipper and two carriers. He can then be added to just one PAS, which brings together all three customers, or be linked to up to three different PASs.

Access Key:

This is a string generated at the start of the connection to the Web Service, by executing the sgrLogin method. It contains the logged-in user's information, such as their login and PAS. Validating this key guarantees data security.

sgrData:

The methods will always be returned in the sgrData format, which is an object composed of the following properties:

  • ReturnDataset: returns a dataset with the requested data;

  • ReturnDescription: stores the messages of possible errors returned by the methods;

  • ReturnID: stores the code of possible errors returned by the methods;

  • ReturnKey: stores the access key returned by the method and used in the other methods.

Important

Having understood these terms, it is necessary to reinforce the need to be sure of the services contracted. This is because, as explained above, the methods to be used vary according to the service contracted. It is therefore recommended that you ask your account manager for a detailed explanation of the rules, products and values that have been set up.