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

<R_Announcements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <DescOrder>false</DescOrder>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <Message>String</Message>
  <NumberOfRecords>0</NumberOfRecords>
  <OnlyRecordsCount>false</OnlyRecordsCount>
  <SortBy>String</SortBy>
  <StartIndex>0</StartIndex>
  <Title>String</Title>
  <ValidTime>0001-01-01T00:00:00</ValidTime>
</R_Announcements>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_Announcement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <CreateDate>0001-01-01T00:00:00</CreateDate>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Id>0</Id>
  <Message>String</Message>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Title>String</Title>
  <TotalNumberOfRecords>0</TotalNumberOfRecords>
  <UpdateDate>0001-01-01T00:00:00</UpdateDate>
</R_Announcement>