CustomerActivityInsertRequest Complex Type

In This Topic

Description

Request object containing customer activity data that will be inserted into the database.

Namespace

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

Diagram

Overview

CustomerActivityInsertRequest

Request object containing customer activity data that will be inserted into the database.

Sequence

CustomerActivity optional CustomerActivity Complex Type

Single CustomerActivity type data structure.

Sequence

ActivityDate optional xs:dateTime

Date of the activity.

Enter a valid Date for Month Day Year (MM/DD/YYYY).

ActivityTime optional duration Simple Type

Time of the activity.

Enter a valid Time as HH:MM AM/PM or 24 Hour HH:MM or HH:MM:SS:mmm AM/PM or 24 Hour HH:MM:SS:mmm.

ClaimId optional guid Simple Type

Globally Unique Identifier (GUID) for a claim.

Insert Validation:
Attaches activity to a claim. PolicyId and TransactionEffectiveDate are required if ClaimId is present and the ClaimId must be valid for that policy.

36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000

CompanyCode optional xs:string

Unique identifier for a company.

Insert Validation:
CompanyCode is usable (optional and validated if present) only if no PolicyId is present. If a PolicyId is present then the policy’s CompanyCode is used and the CompanyCode in the CustomerActivityInsertRequest is not validated and is ignored.

Uniqueness is maintained in AMS360.

Description optional xs:string

Activity text to be inserted.

CustomerId optional guid Simple Type

CustomerId of the customer this activity is attached to.

ActivityAction optional xs:string

Describes the action taken that the activity is written for.

Insert Validation:
Must be a valid value from the ActivityAction list.

Description value from the "ActivityAction" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=ActivityAction

EmployeeCode optional xs:string

Employee code of the AMS360 user who created the activity.

TransactionEffectiveDate optional xs:dateTime

Identifies an endorsement date for a policy.

Insert Validation:
TransactionEffectiveDate is required if PolicyId is present.

Date only (MM/DD/YYYY).

PolicyId optional guid Simple Type

Globally Unique Identifier (GUID) for a policy.

Insert Validation:
Attaches activity to a policy. TransactionEffectiveDate is required if a PolicyId is present.

36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000

ActivityId optional guid Simple Type

Globally Unique Identifier (GUID) for an activity.

Insert Validation:
AMS360 creates on insert.

Attachments optional ArrayOfDoc360Document Complex Type

Files attached to the activity.

Sequence

Doc360Document 0..∞ Doc360Document Complex Type

Sequence

Doc360DocumentId optional guid Simple Type

The id of the temporary location at which the file to be attached is stored. This is returned from calls to EndFileChunk.

Insert Validation:
Required if StorageLocation=DB. Must be null if StorageLocation=RD. If provided, must be the result of EndFileChunk, and not already attached.

36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000. This value must be the result of a call to EndFileChunk, and the file must not have already been attached.

Description optional xs:string

Description of the document being attached.

StorageLocation optional xs:string

Location where the document will be physically stored.

Code value from the "Doc360StorageLocation" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=Doc360StorageLocation

DocumentType optional xs:string

Doc360 Document Type.

Code value from the "Doc360Type" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=Doc360Type

SecurityClass optional xs:string

Document's Doc360 Security Class, obtained from ValueList. ValueList populated based on the WSAPI logged in user, and users will only be allowed to use and see the values for which they are allowed.

Code field from the "Doc360SecurityClass" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=Doc360SecurityClass

Index1 optional xs:string

If your agency utilizes index keywords or numbers as a means to search and retrieve documents, enter an index word or number using your agency-defined indexing method.

In the search and retrieval process, the system matches index keyword data either as a prefix or as a sequence within the word. It matches data exactly as the text is entered in the field. To prevent data entry errors, enter data in this field with care.

Index2 optional xs:string

If your agency utilizes index keywords or numbers as a means to search and retrieve documents, enter an index word or number using your agency-defined indexing method.

Comments optional xs:string

Comment text field for the document.

SourceFileName optional xs:string

The full path of the source file that is being uploaded or referenced. e.g. "c:\somedirectory\somefile.xml"

ReceivedDateTime optional xs:dateTime

The DateTime the file was received.

NOTE: For Activity Attachments, this value is ignored and ReceivedDateTime is set to the server's date and time at the time the document was attached to the activity.

Any Valid DateTime value

ProcessedDateTime optional xs:dateTime

The DateTime the file was processed.

NOTE: For Activity Attachments, this value is ignored and ProcessedDateTime is set to the server's date and time at the time the document was attached to the activity.

Any Valid DateTime value

TotalBytes optional xs:int

The total size of the file being attached, in bytes.

Insert Validation:
Required if StorageLocation="RD"

Any positive integer representing a file size of 100 megabytes or less.

Used By

Request Element
CustomerActivityInsertRequest Element

Source

<xs:complexType name="CustomerActivityInsertRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Request object containing customer activity data that will be inserted into the database.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="CustomerActivity" nillable="true" type="tns:CustomerActivity">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Single CustomerActivity type data structure.
            </summary>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>