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 .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 /jsv/reply/R_Announcements HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		0
	],
	ValidTime: 0001-01-01,
	Title: String,
	Message: String,
	StartIndex: 0,
	NumberOfRecords: 0,
	OnlyRecordsCount: False,
	SortBy: String,
	DescOrder: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Title: String,
	Message: String,
	CreateDate: 0001-01-01,
	UpdateDate: 0001-01-01,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	TotalNumberOfRecords: 0
}