PersonalNote Complex Type

In This Topic

Description

Data structure for a list of personal note entities when retrieving personal note data.

Namespace

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

Diagram

Overview

PersonalNote

Data structure for a list of personal note entities when retrieving personal note data.

Sequence

EmployeeCode optional xs:string

Employee code of the employee assigned to the personal note.

Must be a valid EmployeeCode in the Employee list.

Insert Validation:
Employee must be Active (Status=A).

Update Validation:
Employee must be Active (Status=A) if value is changed.

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 personal 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 personal 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.

IsNoteTruncated optional xs:boolean

Used By

PersonalNote Element
PersonalNote Element
UserNote Element

Source

<xs:complexType name="PersonalNote" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Data structure for a list of personal note entities when retrieving personal note data.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="EmployeeCode" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Employee code of the employee assigned to the personal note.
            </summary>
          <len min="0" max="3" />
          <values>
            Must be a valid EmployeeCode in the Employee list.<br /><br />Insert Validation:<br />Employee must be Active (Status=A).<br /><br />Update Validation:<br />Employee must be Active (Status=A) if value is changed.
            </values>
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="NoteText" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Note text.
            </summary>
          <len min="0" max="8,000" />
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="NoteDate" type="xs:dateTime">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Date of the note.
            </summary>
          <values>
            Date value only (MM/DD/YYYY).
            </values>
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="NoteId" type="ser:guid">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Globally Unique Identifier (GUID) for a personal note.
            </summary>
          <len min="0" max="36" />
          <values>
            Insert Validation:<br />AMS 360 creates on insert.<br /><br />Update Validation:<br />Not available for update.
            </values>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="PurgeDate" nillable="true" type="xs:dateTime">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Purge date of note.
            </summary>
          <values>
            Date value only (MM/DD/YYYY).<br /><br />Insert Validation:<br />Must be current or future date.
            </values>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="Priority" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Priority of note.
            </summary>
          <len min="1" max="1" />
          <values>
            Valid values are: <br />
             N = Normal <br />
             C = Critical <br />
             L = Low
            </values>
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="Attachment" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Indicates if the personal note has an attachment.
            </summary>
          <values>
            Read Only:<br />Not available for insert or update.
            </values>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="IsSticky" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Indicates if the note displays in side bar when user logs in.
            </summary>
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="IsNoteTruncated" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>