UpdateCustomField()

Abstract

The UpdateCustomField() API function is an XmlHttp function allow custom fields on any record to be updated from the API.  The parameters passed through this function are the record type, it’s unique identifier, the custom field id to update and the value to update it to.  Currently only plain text fields can be updated using this API function.

API Address

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

Request Format

The input format XML for this function is as follows:

<?xml version="1.0"?>
<TrackerRMS>
    <WebAPI>
        <UpdateCustomField>
            <UserCredentials>
                <SecurityToken></SecurityToken>
                <Username></Username>
                <Password></Password>
            </UserCredentials>
            <RecordType></RecordType>
            <RecordId></RecordId>
            <CustomFields>
                <CustomField id=””></CustomField>
                <CustomField id=””></CustomField>
                ...
            </CustomFields>
        </UpdateCustomField>
    </WebAPI>
</TrackerRMS>
Parameter Notes
<SecurityToken> This will be the 40 character security token obtained from the LogonUser() function
<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
<RecordType> The record type indicates the type of record required and is set to one of the following values:
Activities             Leads                    Resources                                                                           Accounts             Opportunities     Tickets                                                                       Contacts              Projects
<RecordId> This is the unique record identifier to update and is passed in the UpdateCustomField() function.  This parameter must be populated for this function to be processed successfully
<CustomField> (collection) Each <CustomField> element can hold the id of the field to be updated and the value will be the new value to update it to

Response Format

The function will return the standard RequestStatus section signifying the success of the update.

<?xml version="1.0"?>
<TrackerRMS>
    <WebAPI>
        <RequestStatus>
            <ReturnCode></ReturnCode>
            <ReturnDescription></ReturnDescription>
            <ReturnRecordCount></ReturnRecordCount>
        </RequestStatus>
    </WebAPI>
</TrackerRMS>