GET api/Journals

Retrieves a list of journals for a particular member.

Request

Parameters

Name Description Default
member Unique member ID or member code. Omit to specify self.
from Start of period.
to End of period.

Response

Body

Content Type: application/xml or application/json
Data set containing the journals, or an error message.

XML JSON 
<Response>                                 
  <Result>                                 <!--Array of 'Item'--> 
    <Item>                                 
      <Description>string</Description>    
      <Date>datetime</Date>                <!--Date and start time--> 
      <Units>int</Units>                   <!--Minutes--> 
      <Rate>decimal</Rate>                 <!--Rate per hour--> 
      <Charge>decimal</Charge>             <!--Value of time recorded--> 
      <WrittenOff>decimal</WrittenOff>     <!--Adjustment--> 
      <JournalID>long</JournalID>          <!--Unique journal ID--> 
      <ActivityType>long</ActivityType>    <!--Activity type code--> 
      <DBRecordID>long</DBRecordID>        <!--Primary key of related record--> 
      <ProductID>long</ProductID>          <!--Unique product ID--> 
      <HasNotes>bool</HasNotes>            <!--Whether the journal has notes--> 
      <FileID>long</FileID>                
      <FileNumber>string</FileNumber>      
    </Item>                                
  </Result>                                
  <Message>string</Message>                <!--Error message--> 
</Response>                                
{                                 
   "Result": [{                   
      "Description": "string",    
      "Date": "datetime",         // Date and start time
      "Units": "int",             // Minutes
      "Rate": "decimal",          // Rate per hour
      "Charge": "decimal",        // Value of time recorded
      "WrittenOff": "decimal",    // Adjustment
      "JournalID": "long",        // Unique journal ID
      "ActivityType": "long",     // Activity type code
      "DBRecordID": "long",       // Primary key of related record
      "ProductID": "long",        // Unique product ID
      "HasNotes": "bool",         // Whether the journal has notes
      "FileID": "long",           
      "FileNumber": "string"      
   }],                            
   "Message": "string"            // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid member ID/code or date range.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to list journals.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

You must specify either both date parameters, or neither to use the default (today).