GET api/Announcements

Retrieves a list of practice announcements.

Request

Parameters

Name Description Default
offset Signed integer specifying number of periods before/after the current date. 0

Response

Body

Content Type: application/xml or application/json
List of announcements or an error message.

XML JSON 
<Response>                                   
  <Result>                                   
    <From>datetime</From>                    
    <To>datetime</To>                        
    <CanAddNew>bool</CanAddNew>              
    <Announcements>                          <!--Array of 'Item'--> 
      <Item>                                 
        <ID>long</ID>                        <!--Unique announcement ID or empty if auto-generated--> 
        <Posted>                             
          <Date>datetime</Date>              
          <MemberCode>string</MemberCode>    
        </Posted>                            
        <Title>string</Title>                
        <Body>string</Body>                  
        <IsSticky>bool</IsSticky>            
        <CanEdit>bool</CanEdit>              
      </Item>                                
    </Announcements>                         
  </Result>                                  
  <Message>string</Message>                  <!--Error message--> 
</Response>                                  
{                                    
   "Result": {                       
      "From": "datetime",            
      "To": "datetime",              
      "CanAddNew": "bool",           
      "Announcements": [{            
         "ID": "long",               // Unique announcement ID or empty if auto-generated
         "Posted": {                 
            "Date": "datetime",      
            "MemberCode": "string"   
         },                          
         "Title": "string",          
         "Body": "string",           
         "IsSticky": "bool",         
         "CanEdit": "bool"           
      }]                             
   },                                
   "Message": "string"               // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.