YM REST Services

DomainAuthentication

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

The following routes are available for this service:
GET	/Ams/{ClientID}/DomainAuthentication	Return a list of Domain VerificationInfo under AWS.
POST	/Ams/{ClientID}/DomainAuthentication	Start a new Domain Verification.
PUT	/Ams/{ClientID}/DomainAuthentication	Update an existing Domain Verification.
GET	/Ams/{ClientID}/DomainAuthentication/{DomainId}	Return details of Domain VerificationInfo for given DomainId.
DELETE	/Ams/{ClientID}/DomainAuthentication/{DomainId}	Delete a Domain Verification.

**DomainAuthentication** Parameters:
Name	Parameter	Data Type	Required	Description
Domain	body	string	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

**DomainAuthenticationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DomainAuthenticationInfoList	form	List<DomainAuthenticationInfo>	No
ValidationRoute	form	ValidationRoute	No

**DomainAuthenticationInfo** Parameters:
Name	Parameter	Data Type	Required
DomainId	form	int	No
DomainName	form	string	No
IsYmMangedDomain	form	bool	No
EmailsCount	form	int	No
DomainStatus	form	DomainStatus	No
IdentityZoneRecord	form	ZoneRecord	No
DkimZoneRecords	form	List<ZoneRecord>	No

**DomainStatus** Parameters:
Name	Parameter	Data Type	Required
IdentityStatus	form	Status	No
DkimStatus	form	Status	No
CombinedStatus	form	Status	No
DisplayName	form	string	No

**ZoneRecord** Parameters:
Name	Parameter	Data Type	Required
Host	form	string	No
Value	form	string	No
RecordType	form	string	No
TTL	form	long	No

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

HTTP + JSV

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

POST /Ams/{ClientID}/DomainAuthentication HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Domain: String,
	DomainId: 0,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T07:22:11.6203406-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DomainAuthenticationInfoList: 
	[
		{
			DomainId: 0,
			DomainName: String,
			IsYmMangedDomain: False,
			EmailsCount: 0,
			DomainStatus: 
			{
				IdentityStatus: Undefined,
				DkimStatus: Undefined,
				CombinedStatus: Undefined,
				DisplayName: String
			},
			IdentityZoneRecord: 
			{
				Host: String,
				Value: String,
				RecordType: String,
				TTL: 0
			},
			DkimZoneRecords: 
			[
				{
					Host: String,
					Value: String,
					RecordType: String,
					TTL: 0
				}
			]
		}
	],
	ValidationRoute: Undefined,
	Domain: String,
	DomainId: 0,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T07:22:11.6516081-04:00,
	Device: Desktop
}