CustomerNoteInsertRequest Complex Type

In This Topic

Description

A note data object containing the note data to insert for an customer. On an insert, the NoteId is ignored and a unique NoteId is generated by AMS360 and returned to the caller.

Namespace

https://wsapi.ams360.com/v3.0/DataContract

Diagram

Overview

CustomerNoteInsertRequest

A note data object containing the note data to insert for an customer. On an insert, the NoteId is ignored and a unique NoteId is generated by AMS360 and returned to the caller.

Sequence

CustomerNote optional CustomerNote Complex Type

A customer note data object containing the note data to insert for a customer. On an insert, the NoteId is ignored and a unique NoteId is generated by AMS360 and returned to the caller.

Sequence

CustomerId optional guid Simple Type

Associates this note to a customer.

Must be a valid CustomerId in a division that the WSAPI user has access to.

NoteText optional xs:string

Note text.

NoteDate optional xs:dateTime

Date of the note.

Date value only (MM/DD/YYYY).

NoteId optional guid Simple Type

Globally Unique Identifier (GUID) for a customer note.

Insert Validation:
AMS 360 creates on insert.

Update Validation:
Not available for update.

PurgeDate optional xs:dateTime

Purge date of note.

Date value only (MM/DD/YYYY).

Insert Validation:
Must be current or future date.

Priority optional xs:string

Priority of note.

Valid values are:
N = Normal
C = Critical
L = Low

Attachment optional xs:boolean

Indicates if the customer note has an attachment.

Read Only:
Not available for insert or update.

IsSticky optional xs:boolean

Indicates if the note displays in side bar when user logs in.

ClaimId optional guid Simple Type

Associates this note to a claim.

Must have a PolicyId in order to attach to a claim.

Must be a valid ClaimId for the policy.

PolicyId optional guid Simple Type

Associates this note to a policy.

Must be a valid PolicyId for the customer.

IsNoteTruncated optional xs:boolean

Used By

Request Element
CustomerNoteInsertRequest Element

Source

<xs:complexType name="CustomerNoteInsertRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            A note data object containing the note data to insert for an customer. On an insert, the NoteId is ignored and a unique NoteId is generated by AMS360 and returned to the caller.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="CustomerNote" nillable="true" type="tns:CustomerNote">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            A customer note data object containing the note data to insert for a customer. On an insert, the NoteId is ignored and a unique NoteId is generated by AMS360 and returned to the caller.
            </summary>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>