Appian Web API Documentation

The Appian Web API is a ASP.NET MVC 1.0 RESTful Web Service. You can use it to query the Appian User database for user information. By default, each of the "Actions" on the service return XML responses. If you would like, or require, JSON responses, you must pass a Content-Type: application/json HTTP header with your request.

Click the titles of each section to display usage information.

User Controller

top

Get Appian User by Auid

GET /User?auid={0}

Get information about an Appian user from the database by Appian User Id

Available URL Query parameters:

  • auid — string (length: 9, left zero padded) (example: 000000001)

Show Response (XML) (JSON)

top

Get Active Users by Company Code

GET /User/ActiveUsers?dealercode={0}

Get all active users AUID's at a specific branch. Similar to UserDto without the Branch information.

Available URL Query parameters:

  • dealercode — string (length: 5) (example: 21310)

Show Response (XML) (JSON)

top

Get Active User Information by Company Code

GET /User/ActiveUserInformation?dealercode={0}

Get all active user information for a specific branch

Available URL Query parameters:

  • dealercode — string (length: 5) (example: 15310)

Show Response (XML) (JSON)

Supplemental Classes:

If you are using the .NET Framework to connect to our services via HttpClient, here are the full classes in c-sharp (they could easily be converted to Visual Basic as well) that are returned from this service. You will need to create these (or a sub-select with only the fields you require) within your solution to utilize the service.