| POST | /api/MobileRegistration |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | string | No | |
| Phone | body | string | No | |
| Company | body | string | No | |
| Address1 | body | string | No | |
| Address2 | body | string | No | |
| City | body | string | No | |
| State | body | string | No | |
| body | string | No | ||
| Zip | body | string | No | |
| Password | body | string | No | |
| Action | query | string | Yes | Should be Register or Confirm |
| PasswordToken | body | string | No | |
| OptIn1 | body | bool | No | |
| OptIn2 | body | bool | No | |
| OptIn3 | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| 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 |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/MobileRegistration HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Name":"String","Phone":"String","Company":"String","Address1":"String","Address2":"String","City":"String","State":"String","Email":"String","Zip":"String","Password":"String","Action":"String","PasswordToken":"String","OptIn1":false,"OptIn2":false,"OptIn3":false,"ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}