AIM Web Services

SecurityRequest

Login Service

The following routes are available for this service:
POST	/api/Security
POST	/api/Security/{token}

**SecurityRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Username	query	string	Yes	Employee ID or Customer Email
Token	query	string	No	Existing Token
Password	query	string	Yes	Password of Employee or User
DeviceId	query	string	Yes
AppId	query	string	Yes
Acct	query	int	No
DeviceName	query	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**SecurityResponse** Parameters:
Name	Parameter	Data Type	Required
Token	form	string	No
OAuthToken	form	string	No
Domain	form	string	No
IsAdmin	form	bool	No
UserDetails	form	UserDetail	No
AccountDetails	form	List<AccountDetail>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**UserDetail** Parameters:
Name	Parameter	Data Type	Required
Firstname	form	string	No
LastName	form	string	No
Email	form	string	No
Type	form	string	No
Location	form	string	No
LocationName	form	string	No
AccountNumber	form	int?	No
TaxAuthority	form	string	No
TaxAuthorityName	form	string	No

**AccountDetail** Parameters:
Name	Parameter	Data Type	Required
Acct	form	int	No
AcctType	form	string	No
Name	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Security HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Username":"String","Token":"String","Password":"String","DeviceID":"String","AppID":"String","Acct":0,"DeviceName":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Token":"String","OAuthToken":"String","Domain":"String","IsAdmin":false,"UserDetails":{"Firstname":"String","LastName":"String","Email":"String","Type":"String","Location":"String","LocationName":"String","AccountNumber":0,"TaxAuthority":"String","TaxAuthorityName":"String"},"AccountDetails":[{"Acct":0,"AcctType":"String","Name":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}