CreateActivity()

Abstract

The CreateActivity() API function is an XmlHttp function to create a new activity record based on the core details of the activity.

API Address

https://api.tracker-rms.com/WebAPI/XmlHttpCreateActivity.aspx

Request Format

The input format XML for this function is as follows:

<?xml version="1.0"?>
<TrackerRMS>
    <UserLogon>
        <Username></Username>
        <Password></Password>
    </UserLogon>
    <ActivityRecord>
        <Subject></Subject>
        <ActivityType></ActivityType>
        <StartDate></StartDate>
        <EndDate></EndDate>
        <StartTime></StartTime>
        <EndTime></EndTime>
        <Note></Note>
        <Status></Status>
        <RecordType></RecordType>
        <RecordId></RecordId>
    </ActivityRecord>
</TrackerRMS>
Parameter Notes
<Username> The username is typically the email address for the user in the format name@domain.com
<Password> The password will be the same as their web based password and can contain a combination of upper case, lower case and alpha-numeric characters
<Subject> This is the appoint subject to be used for the new Activity record
<ActivityType> This will be the Type of Activity to create, e.g. Telephone, Appointment, Task, Email, Fax, Marketing, Text, Letter
<StartDate> This is the start date for the new Activity record
<EndDate> This is the end date for the new Activity record
<StartTime> This is the start time for the new Activity record
<EndTime> This is the end time for the new Activity record
<Note> This is the appointment body note text to be used for the new Activity record
<Status> Optional: The Status to apply to the Activity (default is “Not Started”).  Options are “Not Started”, “Completed”, “Follow Up”, “No Answer”, “Deferred”, “Left Message”, “Waiting”
<RecordType> Optional: This is the associated Record Type, for example Contact or Resource or User to which the Activity will be related
<RecordId> Optional: This is the associated Record Id to which the Activity will be related

Response Format

The function will return a literal string value only containing the message to relay to the sender.

Example of a valid return:

No Default Ticket Type has been defined, please speak to your System Administrator
Contact does not exist or cannot be found with a valid email address of ‘some.one@domain.com’
User details cannot be verified
User ‘sender@domain.com’ not found
Record ‘TKT-00000’ successfully created