Needio.Services.ExtApiHost

GetAnnouncementRequest

The following routes are available for this service:
All Verbs	/Genel/GetAnnouncement

**GetAnnouncementRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Module	query	string	No
ModuleKey	query	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**GetAnnouncementResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Announcement	form	AnnouncementDto	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**AnnouncementDto** Parameters:
Name	Parameter	Data Type	Required
AnnouncementId	form	int	No
Name	form	string	No
AnnouncementType	form	AnnouncementType	No
ShowLimitType	form	ShowLimitType	No
AnnouncementModuleId	form	int	No
Module	form	string	No
ModuleKey	form	string	No
UserCheckType	form	UserCheckType	No
PopupContent	form	string	No
ActiveYn	form	bool	No
BeginDate	form	DateTime?	No
EndDate	form	DateTime?	No
Priority	form	int	No
MobileYn	form	bool	No
WebYn	form	bool	No

**AnnouncementType** Enum:
Name	Value
Single	1
Perkey	2

**ShowLimitType** Enum:
Unlimited
OneTime
NewerShow

**UserCheckType** Enum:
Name	Value
PerUser	1
PerDevice	2
PerAll	3

**GetAnnouncementResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Announcement	form	AnnouncementDto	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetAnnouncementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Module>String</Module>
  <ModuleKey>String</ModuleKey>
</GetAnnouncementRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAnnouncementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Announcement xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:AnnouncementId>0</d2p1:AnnouncementId>
    <d2p1:AnnouncementModuleId>0</d2p1:AnnouncementModuleId>
    <d2p1:AnnouncementType>Single</d2p1:AnnouncementType>
    <d2p1:BeginDate>0001-01-01T00:00:00</d2p1:BeginDate>
    <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
    <d2p1:MobileYn>false</d2p1:MobileYn>
    <d2p1:Module>String</d2p1:Module>
    <d2p1:ModuleKey>String</d2p1:ModuleKey>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:PopupContent>String</d2p1:PopupContent>
    <d2p1:Priority>0</d2p1:Priority>
    <d2p1:ShowLimitType>Unlimited</d2p1:ShowLimitType>
    <d2p1:UserCheckType>PerUser</d2p1:UserCheckType>
    <d2p1:WebYn>false</d2p1:WebYn>
  </Announcement>
</GetAnnouncementResponse>