YM REST Services

Certifications

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Certifications	Return a list of all certification records for the community or a list of Certifications for the specified user.
GET	/Ams/{ClientID}/Member/{MemberID}/Certifications	Return a list of Certifications for the specified user.

**Certifications** Parameters:
Name	Parameter	Data Type	Required
PersonID	query	int	No
IsActive	query	bool?	No
IncludeInactive	query	bool?	No
PageSize	query	int?	No
PageNumber	query	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

**CertificationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CertificationList	form	List<Certification>	No
TotalCount	form	int?	No

**Certification** Parameters:
Name	Parameter	Data Type	Required
CertificationID	form	string	No
ID	form	string	No
Name	form	string	No
VisibleOnProfile	form	bool?	No
IsActive	form	bool	No
CEUsEarned	form	int?	No
CEUsRequired	form	int	No
CEUsExpireDate	form	DateTime?	No
CEUsExpiring	form	int?	No
Code	form	string	No
CreditTypeList	form	List<CreditType>	No
PrerequisiteList	form	List<Prerequisite>	No

**CreditType** Parameters:
Name	Parameter	Data Type	Required
Mode	form	int	No
ID	form	int	No
Name	form	string	No
Code	form	string	No
CEUsRequired	form	int?	No
MaxCredits	form	double?	No

**Prerequisite** Parameters:
Name	Parameter	Data Type	Required
CertificationID	form	string	No
ID	form	string	No
Name	form	string	No
Code	form	string	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.

GET /Ams/{ClientID}/Certifications HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	CertificationList: 
	[
		{
			CertificationID: String,
			ID: String,
			Name: String,
			VisibleOnProfile: False,
			IsActive: False,
			CEUsEarned: 0,
			CEUsRequired: 0,
			CEUsExpireDate: 0001-01-01,
			CEUsExpiring: 0,
			Code: String,
			CreditTypeList: 
			[
				{
					Mode: 0,
					ID: 0,
					Name: String,
					Code: String,
					CEUsRequired: 0,
					MaxCredits: 0
				}
			],
			PrerequisiteList: 
			[
				{
					CertificationID: String,
					ID: String,
					Name: String,
					Code: String
				}
			]
		}
	],
	TotalCount: 0,
	PersonID: 0,
	IsActive: False,
	IncludeInactive: False,
	PageSize: 0,
	PageNumber: 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-03T05:05:56.6094561-04:00,
	Device: Desktop
}