YM REST Services

EmailVerification

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin, admin, oauthadmin, admin, oauthadmin, admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/EmailVerification	Return a list of email verificationInfo under AWS.
POST	/Ams/{ClientID}/EmailVerification	Start a new email verification.
GET	/Ams/{ClientID}/EmailVerification/{DomainId}	Return a list of email verificationInfo under given Domainid.
POST	/Ams/{ClientID}/EmailVerification/{DomainId}	Start a new email verification under given DomainId.
PUT	/Ams/{ClientID}/EmailVerification/{EmailId}	Update an admin announcement details.
DELETE	/Ams/{ClientID}/EmailVerification/{EmailId}	Delete an email verification.

**EmailVerification** Parameters:
Name	Parameter	Data Type	Required
EmailId	path	int	No
Email	body	EmailAddress	No
IsReSend	body	bool	No
DomainId	path	int	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**EmailAddress** Parameters:
Name	Parameter	Data Type	Required
Address	form	string	No
DisplayName	form	string	No
Host	form	string	No
User	form	string	No

**EmailVerificationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EmailverificationInfoList	form	List<EmailverificationInfo>	No

**EmailverificationInfo** Parameters:
Name	Parameter	Data Type	Required
EmailId	form	int	No
Email	form	EmailAddress	No
EmailStatus	form	EmailStatus	No
DomainId	form	int	No

**EmailStatus** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	Status	No
DisplayName	form	string	No

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.

POST /Ams/{ClientID}/EmailVerification HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EmailVerification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <DomainId>0</DomainId>
  <Email xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:Address i:nil="true" />
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Host>String</d2p1:Host>
    <d2p1:User>String</d2p1:User>
  </Email>
  <EmailId>0</EmailId>
  <IsReSend>false</IsReSend>
</EmailVerification>

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

<EmailVerificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <DomainId>0</DomainId>
  <Email xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:Address i:nil="true" />
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Host>String</d2p1:Host>
    <d2p1:User>String</d2p1:User>
  </Email>
  <EmailId>0</EmailId>
  <IsReSend>false</IsReSend>
  <EmailverificationInfoList xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:EmailIdentityVerification.EmailverificationInfo>
      <d2p1:DomainId>0</d2p1:DomainId>
      <d2p1:Email>
        <d2p1:Address i:nil="true" />
        <d2p1:DisplayName>String</d2p1:DisplayName>
        <d2p1:Host>String</d2p1:Host>
        <d2p1:User>String</d2p1:User>
      </d2p1:Email>
      <d2p1:EmailId>0</d2p1:EmailId>
      <d2p1:EmailStatus>
        <d2p1:DisplayName>String</d2p1:DisplayName>
        <d2p1:Status>Undefined</d2p1:Status>
      </d2p1:EmailStatus>
    </d2p1:EmailIdentityVerification.EmailverificationInfo>
  </EmailverificationInfoList>
</EmailVerificationResponse>