Example: Get operation with WSGet

Example using WSGet

In this sample REST function the number of users from the users table of a database is returned.

PUBLIC FUNCTION getNumberUsers()
  ATTRIBUTES(WSGet, 
             WSPath = "/users/count",
             WSDescription = "Returns a count of users")
  RETURNS INTEGER
    DEFINE cnt INTEGER
    SELECT COUNT(*) INTO cnt FROM users
    RETURN cnt
END FUNCTION

Example using WSGet to return all users

In this sample REST function all users are returned. The WSGet attribute is set to request data from the service. An example of the resource URL is:

http://myhost:6394/gas/ws/r/myGroup/myXcf/Account/users

TYPE profileType RECORD
     id INTEGER,
     name VARCHAR(100),
     email VARCHAR(255),
     category VARCHAR(10),
     status INTEGER,
     ccode VARCHAR(3)
     # ...
   END RECORD

PUBLIC FUNCTION getAllUsers()
  ATTRIBUTES(WSGet,
             WSPath = "/users",
             WSDescription = "Returns all user profiles"
             )
  RETURNS (DYNAMIC ARRAY OF profileType )

    DEFINE arr DYNAMIC ARRAY OF profileType
    DEFINE i INTEGER = 1
    
    # code to get users
     DECLARE usersCurs CURSOR FOR SELECT id, name FROM users ORDER BY name
     FOREACH usersCurs INTO arr[i].*
       LET i = i+1
     END FOREACH
     CALL arr.deleteElement(arr.getLength())
     # Remove the empty element implied by reference in FOREACH loop
  RETURN arr
END FUNCTION