PolicyContact Element

In This Topic

Description

Single policy contact type data structure.

Namespace

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

Type

PolicyContact Complex Type

Diagram

Overview

PolicyContact optional PolicyContact Complex Type

Single policy contact type data structure.

Sequence

PolicyId optional guid Simple Type

Globally Unique Identifier (GUID) for a policy.

Insert Validation:
Policy with this PolicyId must exist.

Update Validation:
Policy with this PolicyId must exist.

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

LineOfBusinessId optional guid Simple Type

Globally Unique Identifier (GUID) for this line of business.

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

Valid value is empty GUID.

PolicyContactId optional guid Simple Type

Globally Unique Identifier (GUID) for a policy contact.

Insert Validation:
AMS360 creates on insert.

Update Validation:
Must be a valid PolicyContactId for the policy.

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

EffectiveDate optional xs:dateTime

The date the policy becomes effective.

Must be the complete DateTime value (in string format) of the TransactionEffectiveDate contained in an PolicyTransaction entity returned during a GetPolicy request.

This field uniquely identifies a specific policy transaction for the policy.

The Date component specifies the endorsement effective date and the Time component contains the transaction sequence number for that date using the second's value as a zero based counter.

For example the second policy endorsement on 5/1/2008 will have a TransactionEffectiveDate of '5/1/2008 12:00:01 AM'

Status optional xs:string

Indicates the status of a policy contact.

Insert Validation:
Not available for insert. This value is ignored and no error message is returned.

Update Validation:
Not available for update. This value is ignored and no error message is returned.

Valid values are:
A = Add
C = Change
D = Delete

AttachId optional guid Simple Type

Unique identifier used in conjunction with the PolID, LOBId, and EffDate to uniquely identify a row in the table.

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

AttachId should be equal to PolicyId

AttachType optional xs:short

Uniquely identifies a table in the database.

Valid value: 26

Name optional xs:string

Name of contact.

Responsibility optional xs:string

Individual contact responsibility.

Code value from the "Responsibility" value list for AttrCode = 'RES'.

If you know the name of a value list and only need the contents of the list, you can retrieve the list using the ValueListGet() method.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=Responsibility

Description optional xs:string

Description

AreaCode optional xs:string

Area code portion of the phone number.

Phone optional xs:string

Phone portion of the phone number.

Insert Validation:
Required if area code exists.

Update Validation:
Required if area code exists.

Ext optional xs:string

Extension portion of the phone number.

Address1 optional xs:string

First line of address.

Address2 optional xs:string

Second line of address.

City optional xs:string

City portion of address.

State optional xs:string

StateState portion of address.

Code value from the "State" value list for AttrCode = 'STA'.

If you know the name of a value list and only need the contents of the list, you can retrieve the list using the ValueListGet() method.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=State

ZipCode optional xs:string

Zip code portion of address.

ZipCode must be formatted as one of: 99999, 999999999, or A9A9A9.

County optional xs:string

County portion of address.

RefNo optional xs:string

Reference number.

Title optional xs:string

Policy contact's title.

FormalSalutation optional xs:string

Salutation used in formal correspondence.

InformalSalutation optional xs:string

Salutation used in informal correspondence.

ResidenceAreaCode optional xs:string

Area code portion of the residence phone number.

ResidencePhone optional xs:string

Phone portion of the residence phone number.

Insert Validation:
Required if residence area code exists.

Update Validation:
Required if residence area code exists.

ResidenceExt optional xs:string

Extension portion of the residence phone number.

FaxAreaCode optional xs:string

Area code portion of the fax phone number.

FaxPhone optional xs:string

Phone portion of the fax phone number.

Insert Validation:
Required if fax area code exists.

Update Validation:
Required if fax area code exists.

FaxExt optional xs:string

Extension portion of the fax phone number.

MobileAreaCode optional xs:string

Area code portion of the mobile phone number.

MobilePhone optional xs:string

Phone portion of the mobile phone number.

Insert Validation:
Required if mobile area code exists.

Update Validation:
Required if mobile area code exists.

MobileExt optional xs:string

Extension portion of the mobile phone number.

PagerAreaCode optional xs:string

Area code portion of the pager phone number.

PagerPhone optional xs:string

Phone portion of the pager phone number.

Insert Validation:
Required if pager area code exists.

Update Validation:
Required if pager area code exists.

PagerExt optional xs:string

Extension portion of the pager phone number.

EMail optional xs:string

Electronic mail address.

Source

<xs:element minOccurs="0" name="PolicyContact" nillable="true" type="tns:PolicyContact" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Single policy contact type data structure.
            </summary>
      <required />
    </xs:documentation>
  </xs:annotation>
</xs:element>