GET | /api/SecurityItems |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Mode | query | string | No | Can be ALL to return all security items, HAS to return all items the logged in user has permissions for, or LACKS to return all items the logged in user lacks permissons for. Defaults to HAS if not sent. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Token | Header | string | No | |
DeviceId | Header | string | No | |
AppId | Header | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
OAuthToken | header | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | form | List<SecurityItemInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | body | BaseResponseResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SecurityId | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/SecurityItems HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SecurityItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService"> <Status> <DomainName>String</DomainName> <ErrorCode>String</ErrorCode> <ErrorDisplayText>String</ErrorDisplayText> <ErrorMessage>String</ErrorMessage> <IpAddress>String</IpAddress> <Login>String</Login> <StatusCode>String</StatusCode> </Status> <Items> <SecurityItemInfo> <Description>String</Description> <SecurityId>String</SecurityId> </SecurityItemInfo> </Items> </SecurityItemsResponse>