Needio.Services.ExtApiHost

<back to all web services

GetAnnouncementRequest

The following routes are available for this service:
All Verbs/Genel/GetAnnouncement
GetAnnouncementRequest Parameters:
NameParameterData TypeRequiredDescription
ModulequerystringNo
ModuleKeyquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
GetAnnouncementResponse Parameters:
NameParameterData TypeRequiredDescription
AnnouncementformAnnouncementDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
AnnouncementDto Parameters:
NameParameterData TypeRequiredDescription
AnnouncementIdformintNo
NameformstringNo
AnnouncementTypeformAnnouncementTypeNo
ShowLimitTypeformShowLimitTypeNo
AnnouncementModuleIdformintNo
ModuleformstringNo
ModuleKeyformstringNo
UserCheckTypeformUserCheckTypeNo
PopupContentformstringNo
ActiveYnformboolNo
BeginDateformDateTime?No
EndDateformDateTime?No
PriorityformintNo
MobileYnformboolNo
WebYnformboolNo
AnnouncementType Enum:
NameValue
Single1
Perkey2
ShowLimitType Enum:
Unlimited
OneTime
NewerShow
UserCheckType Enum:
NameValue
PerUser1
PerDevice2
PerAll3
GetAnnouncementResponse Parameters:
NameParameterData TypeRequiredDescription
AnnouncementformAnnouncementDtoNo

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.

POST /Genel/GetAnnouncement HTTP/1.1 
Host: apiservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Module":"String","ModuleKey":"String","start":"\/Date(-62135596800000-0000)\/","DeviceUUID":"String","APIKey":"String","isAdmin":false,"Cmd":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Announcement":{"AnnouncementId":0,"Name":"String","AnnouncementType":"Single","ShowLimitType":"Unlimited","AnnouncementModuleId":0,"Module":"String","ModuleKey":"String","UserCheckType":"PerUser","PopupContent":"String","ActiveYn":false,"BeginDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","Priority":0,"MobileYn":false,"WebYn":false},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ExYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}