/v3/WSAPIService.svc/PersonalNoteInsert (Method)

Method

/v3/WSAPIService.svc/PersonalNoteInsert

In This Topic

Description

Inserts a new personal note.

Request (WSAPIServiceContract_PersonalNoteInsert_InputMessage)

The request body is of type PersonalNoteInsert.

Request Body Parameters

Name	Description	Data Type
Request	Message request object containing the personal note data to insert.	PersonalNoteInsertRequest

Overview

PersonalNoteInsert

Sequence

Request optional PersonalNoteInsertRequest Complex Type

Message request object containing the personal note data to insert.

Sequence

UserNote optional PersonalNote Complex Type

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

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

Response (WSAPIServiceContract_PersonalNoteInsert_OutputMessage)

The response body is of type PersonalNoteInsertResponse.

Response Body Parameters

Name	Description	Data Type
PersonalNoteInsertResult	Message response object containing the NoteId of the personal note.	PersonalNoteInsertResponse

Overview

PersonalNoteInsertResponse

Sequence

PersonalNoteInsertResult optional PersonalNoteInsertResponse Complex Type

Message response object containing the NoteId of the personal note.

Sequence

NoteId optional guid Simple Type

Globally Unique Identifier (GUID) for a row in the Note table.

Fault Responses

Fault	Description
WSAPISecurityFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PersonalNoteInsert_WSAPISecurityFaultFault_FaultMessage.
WSAPIBusinessFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PersonalNoteInsert_WSAPIBusinessFaultFault_FaultMessage.
WSAPIGeneralFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PersonalNoteInsert_WSAPIGeneralFaultFault_FaultMessage.