YM REST Services

<back to all web services

FreestoneTypes

Requires Authentication
Requires the role:admin
The following routes are available for this service:
GET/Ams/{ClientID}/FreestoneTypesReturn the Freestone types.
FreestoneTypes Parameters:
NameParameterData TypeRequiredDescription
TypesqueryTypeFlagsNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FreestoneTypesResponse Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
ProductTypesformIEnumerable<TypeItem>No
CourseTypesformIEnumerable<TypeItem>No
TypeItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
CodeformstringNo

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}/FreestoneTypes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Enabled":false,"Types":1,"UsingRedis":true,"AppInitTime":"2025-01-22T19:43:05.1667787-05:00","ServerID":"WS-6-103-374","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":"2025-01-22T20:55:55.8919812-05:00","Device":"Desktop"}