GET api/Journals/Rate

Retrieves rate and billing scale information for a member.

Request

Parameters

Name Description Default
file Unique file ID or file number. Omit to retrieve default activity rate.
member Unique member ID or member code.

Response

Body

Content Type: application/xml or application/json
Rate details or an error message.

XML JSON
<Response>                                   
  <Rate>decimal</Rate>                       <!--Rate per hour--> 
  <Scale>                                    
    <ID>long</ID>                            <!--Unique scale ID--> 
    <Description>string</Description>        <!--Name of billing scale--> 
  </Scale>                                   
  <EffectiveFrom>datetime</EffectiveFrom>    
</Response>                                  
{                                
   "Rate": "decimal",            // Rate per hour
   "Scale": {                    
      "ID": "long",              // Unique scale ID
      "Description": "string"    // Name of billing scale
   },                            
   "EffectiveFrom": "datetime"   
}                                
                                 

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid file or member.
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.