YM REST Services

<back to all web services

EmailSendersInfo

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/EmailSenderInfoReturn the list of Admin Email Sender information.
EmailSendersInfo Parameters:
NameParameterData TypeRequiredDescription
blnReturnAllqueryboolNo
blnIncludeDefaultqueryboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EmailSendersInfoResponse Parameters:
NameParameterData TypeRequiredDescription
EmailSenderListformList<EmailSenderInfo>No
EmailSenderInfo Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
DisplayformstringNo
StatusformStatusNo
IsDefaultformboolNo

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

{"EmailSenderList":[{"Address":"String","Display":"String","Status":"Undefined","IsDefault":false}],"blnReturnAll":false,"blnIncludeDefault":false,"UsingRedis":true,"AppInitTime":"2024-05-03T05:46:12.1249200-04:00","ServerID":"WS-4-7-585","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-03T08:43:50.3195382-04:00","Device":"Desktop"}