Needio.Services

<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
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:
NameValue
Unlimited0
OneTime1
NewerShow2
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 .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 /Genel/GetAnnouncement HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Module: String,
	ModuleKey: String,
	start: 0001-01-01,
	DeviceUUID: String,
	APIKey: String,
	isAdmin: False,
	Cmd: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Announcement: 
	{
		AnnouncementId: 0,
		Name: String,
		AnnouncementType: 1,
		ShowLimitType: 0,
		AnnouncementModuleId: 0,
		Module: String,
		ModuleKey: String,
		UserCheckType: 1,
		PopupContent: String,
		ActiveYn: False,
		BeginDate: 0001-01-01,
		EndDate: 0001-01-01,
		Priority: 0,
		MobileYn: False,
		WebYn: False
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}