Users Resource

The Users Resource allows read/write access to the Sage Data Exchange User table and for Customer and Vendor linked Users, read access to several Sage 100 ERP tables. Administrators have no direct link to a Customer or Vendor, so only User table columns are returned for Administrators. Data can be posted to the Sage Data Exchange User table and retrieved from any of the Resource Tables listed.

Resource Method List
ActionHTTPURIAdmin?Description
getGET/usersRetrieve user data for the currently logged in user.
listGET/users[?user=<user>]OnlyAdministrators can retrieve data from one or many users.
loginPOST/users?method=loginLog into the Sage Data Exchange API
updatePOST/users?method=update&user=<user>YesUpdate user information
deactivatePOST/users?method=deactivate&user=<user>OnlyChange an exiting user to Inactive
activatePOST/users?method=activate&user=<user>OnlyChange an exiting user to Active

Resource Table List
Click on the table to view detail.

User

Element NameDescriptionTypeLength
userUserString32
userRIDUser Reference IDString8
userNameUser NameString64
emailAddressEmail AddressString128
passwordPasswordString32
userTypeUser TypeString1
statusStatusString1
ARDivisionNoAR Division NumberString2
customerNoCustomer NumberString20
customerContactCodeCustomer Contact CodeString10
APDivisionNoAP Division NumberString2
vendorNoVendor NumberString7
vendorContactCodeVendor Contact CodeString10


Get

Users can retrieve their own data from the Users Resource. Select the columns to be returned in Return Maintenance. Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources.

List

Administrators can retrieve any users data from the Users Resource by specifying a user in the URI. If the Administrator leaves the user field off the URI, then a list of all users, not administrators, is returned.

Login

The client must provide credentials In order to access the Sage Data Exchange API. The Users Login method requires the method name in the URI and the User and Password in the document passed. (The User and Password can also be provided on the URI.) Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources. A successful login returns a GUID that is used in every subsequent conversation with the API. In addition, the columns selected in Return Maintenance for the Users resource are returned. Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources. A failed login attempt will return an HTTP Error 401, Unauthorized.

Update

Users can update their own data, while Administrators can update any users data.

Create

Only an Administrator can create a new User.

Deactivate

Only Administrators can change a user from Active to Inactive, removing the users access to the Sage Data Exchange API. Users cannot actually be deleted by the API.

Activate

Only Administrators can change a user from Inactive to Active, restoring the users access to the Sage Data Exchange API. Users cannot actually be added by the API.