AIM Web Services

<back to all web services

CheckEmailRequest

CheckEmail
Requires active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/CheckEmail
CheckEmailRequest Parameters:
NameParameterData TypeRequiredDescription
EmailquerystringNo
WebIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
CheckEmailResponse Parameters:
NameParameterData TypeRequiredDescription
AccountInfoformList<AccountInfo>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EnabledformboolNo

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

HTTP + XML

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

GET /api/CheckEmail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<CheckEmailResponse 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>
  <AccountInfo>
    <AccountInfo>
      <Enabled>false</Enabled>
      <Id>0</Id>
    </AccountInfo>
  </AccountInfo>
</CheckEmailResponse>