Registrar Web Services

<back to all web services

R_Announcements

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Announcements
R_Announcements Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<long>No
ValidTimequeryDateTime?No
TitlequerystringNo
MessagequerystringNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No
OnlyRecordsCountqueryboolNo
SortByquerystringNo
DescOrderqueryboolNo
R_Announcement Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TitleformstringNo
MessageformstringNo
CreateDateformDateTimeNo
UpdateDateformDateTime?No
StartDateformDateTimeNo
EndDateformDateTimeNo
TotalNumberOfRecordsformlongNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/R_Announcements HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/json
Content-Length: length

{"Ids":[0],"ValidTime":"\/Date(-62135596800000-0000)\/","Title":"String","Message":"String","StartIndex":0,"NumberOfRecords":0,"OnlyRecordsCount":false,"SortBy":"String","DescOrder":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Title":"String","Message":"String","CreateDate":"\/Date(-62135596800000-0000)\/","UpdateDate":"\/Date(-62135596800000-0000)\/","StartDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0}