YM REST Services

<back to all web services

CertificationCreditTypes

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CertificationCreditTypesReturn a list of all certifications credit types for the community.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CertificationCreditTypesResponse Parameters:
NameParameterData TypeRequiredDescription
CreditTypeListformList<CreditTypes>No
TotalCountformintNo
CreditTypes Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
CodeformstringNo
NameformstringNo
DescriptionformstringNo
IsDefaultformboolNo
CreditsExpireformboolNo

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

HTTP + CSV

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

GET /Ams/{ClientID}/CertificationCreditTypes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CreditTypeList":[{"ID":0,"Code":"String","Name":"String","Description":"String","IsDefault":false,"CreditsExpire":false}],"TotalCount":0,"UsingRedis":true,"AppInitTime":"2024-05-03T08:24:51.9748751-04:00","ServerID":"WS-6-183-431","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-03T10:28:41.4145812-04:00","Device":"Desktop"}