YM REST Services

CertificationsJournals

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

The following routes are available for this service:
GET	/Ams/{ClientID}/CertificationsJournals	Return a list of Certification Journal Entries for the specified user that may be optionally filterd by date, expiration, and paging.
POST	/Ams/{ClientID}/CertificationsJournals	Create a CEU Journal Entry.
GET	/Ams/{ClientID}/Member/{MemberID}/CertificationsJournals	Return a list of Certification Journal Entries for the signed in user that may be optionally filtered by date, expiration, and paging.

**CertificationsJournals** Parameters:
Name	Parameter	Data Type	Required
ShowExpired	body	bool?	No
StartDate	body	DateTime?	No
EntryID	body	int?	No
PageSize	body	int	No
PageNumber	body	int	No
OffSet	body	int	No
CEUsEarned	body	float	No
CEUsExpireDate	body	DateTime?	No
CertificationName	body	string	No
Description	body	string	No
EntryDate	body	DateTime?	No
ScorePercent	body	decimal	No
CreditTypeCode	body	string	No
Status	body	string	No
PersonID	body	int	No
CertificationID	body	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

**CertificationsJournalsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CertificationsJournalList	form	List<CertificationJournal>	No

**CertificationJournal** Parameters:
Name	Parameter	Data Type	Required
EntryID	form	int	No
CertificationID	form	int?	No
CertificationName	form	string	No
Description	form	string	No
Score	form	double?	No
IsActive	form	bool	No
CEUsEarned	form	int	No
CEUsExpire	form	DateTime?	No
Locked	form	bool	No
IsMemberEntry	form	bool	No
EntryDate	form	DateTime?	No
EntryCreated	form	DateTime?	No
Status	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.

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

{
	ShowExpired: False,
	StartDate: 0001-01-01,
	EntryID: 0,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	CEUsEarned: 0,
	CEUsExpireDate: 0001-01-01,
	CertificationName: String,
	Description: String,
	EntryDate: 0001-01-01,
	ScorePercent: 0,
	CreditTypeCode: String,
	Status: String,
	PersonID: 0,
	CertificationID: 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-03T02:43:55.7013834-04:00,
	Device: Desktop
}

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

{
	CertificationsJournalList: 
	[
		{
			EntryID: 0,
			CertificationID: 0,
			CertificationName: String,
			Description: String,
			Score: 0,
			IsActive: False,
			CEUsEarned: 0,
			CEUsExpire: 0001-01-01,
			Locked: False,
			IsMemberEntry: False,
			EntryDate: 0001-01-01,
			EntryCreated: 0001-01-01,
			Status: String
		}
	],
	ShowExpired: False,
	StartDate: 0001-01-01,
	EntryID: 0,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	CEUsEarned: 0,
	CEUsExpireDate: 0001-01-01,
	CertificationName: String,
	Description: String,
	EntryDate: 0001-01-01,
	ScorePercent: 0,
	CreditTypeCode: String,
	Status: String,
	PersonID: 0,
	CertificationID: 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-03T02:43:55.7238537-04:00,
	Device: Desktop
}