The GetList Web service allows a client to retrieve a set of predefined columns from tables in the database. These columns are named Id, Code, Description, and Active. The same Web service also allows the user to get a list of updatable fields for a transaction.
The message sent to the Web service is called a request. The message received containing the information is called a response. The request message contains the InMsgs (in-messages). The InMsgs are classified into three types, Simple, Filtered, and Custom.
-
A SimpleInMsg sends three parameters in the request:
- The EntityType – Typically the name of the table.
- An ActiveOnly Flag – Requesting all or only active items returned.
- CampusIds – A collection of Campuses, can be all ,one , or many.
Returns a ListSimpleOutMsg with id, Code, Description, and Active.
-
A FilteredInMsg has three parameters and a collection of custom attributes in the request:
- The EntityType – Typically the name of the table.
- An ActiveOnly Flag – Requesting all or only active items returned.
- CampusIds – A collection of Campuses, can be all ,one, or many.
- CustomAttributes – Each custom attribute is a value / key pair.
Returns a ListFilteredOutMsg with Id, Code, Description, and Active.
-
A CustomInMsg has three parameters and a collection of custom attributes in the request:
- The EntityType – Typically the name of the table.
- An ActiveOnly Flag – Requesting all or only active items returned.
- CampusIds – A collection of Campuses, can be all, one, or many.
- CustomAttributes – Each custom attribute is a value / key pair
Returns a ListCustomOutMsg with Id, Code, Description, and Active, and a collection of custom attributes.
In addition to these parameters, out-messages also contain status and transaction information to report success or errors.
For security reasons, a token, which is requested from the Authentication service, must be provided with the request.
Topics in this section:
