EmployeeGetByCodeResponse Complex Type

In This Topic

Description

Response object containing a single employee entity having the requested code.

Namespace

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

Diagram

Overview

EmployeeGetByCodeResponse

Response object containing a single employee entity having the requested code.

Sequence

Employee optional EmployeeWithBusinessUnits Complex Type

Sequence

Address optional xs:string

First line of employee address.

AddressLine2 optional xs:string

Second line of employee address.

BusinessAreaCode optional xs:string

Area code portion of the business phone number.

BusinessExtension optional xs:string

Extension portion of the business phone number.

BusinessPhone optional xs:string

Phone portion of the business phone number.

Insert Validation:
Required if business area code exists.

Update Validation:
Required if business area code exists.

City optional xs:string

City for employee address.

EmergencyContactAreaCode optional xs:string

Area code portion of the emergency contact phone number.

EmergencyContactExtension optional xs:string

Extension portion of the emergency contact phone number.

EmergencyContactPhone optional xs:string

Phone portion of the emergency contact phone number.

Insert Validation:
Required if emergency contact area code exists.

Update Validation:
Required if emergency contact area code exists.

DateOfBirth optional xs:dateTime

Employee's date of birth.

Doc360HotFolderLocation optional xs:string

Identifies the folder location this employee is assigned to for retrieving electronic documents in AMS360 Doc360.

Email optional xs:string

Email address for the employee.

EmergencyContactName optional xs:string

Emergency contact for this employee.

EmployeeCode optional xs:string

Unique identifier for an employee.

Uniqueness is maintained in AMS360.

EmployeeSupervisorCode optional xs:string

Three character employee code for this employee's supervisor.

FaxAreaCode optional xs:string

Area code portion of the fax phone number.

FaxExtension optional xs:string

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

FirstName optional xs:string

Employee's first name.

FullTimeOrPartTime optional xs:string

Indicates whether the employee works full or part time.

F for full time
P for part time.

HomeAreaCode optional xs:string

Area code portion of the home phone number.

HomeExtension optional xs:string

Extension portion of the home phone number.

HomePhone optional xs:string

Phone portion of the home phone number.

Insert Validation:
Required if home area code exists.

Update Validation:
Required if home area code exists.

LicensedAgent optional xs:boolean

Indicates whether the employee is a licensed agent (true) or not (false).

AllowMemoCommissions optional xs:boolean

Indicates whether or not commission is paid to this employee. If set to 'True', commissions are calculated for reporting purposes only and posted to the general ledger table as memo commissions.

Executive optional xs:boolean

Indicates whether the employee is designated as an account executive in the agency.

Representative optional xs:boolean

Indicates whether the employee is designated as an account service representative in the agency.

SalesCenterRepresentative optional xs:boolean

Indicates whether the employee is designated as a sales center representative or telemarketer in the agency.

LastName optional xs:string

Employee's last name.

LogDownloadSuspense optional xs:boolean

Indicates whether a suspense item should be written for this employee when policy or accounting transactions are received in download that require customer assignment or when email is received.

MiddleName optional xs:string

Employee's middle name.

CellAreaCode optional xs:string

Area code portion of the cell phone number.

CellExtension optional xs:string

Extension portion of the cell phone number.

CellPhone optional xs:string

Phone portion of the cell phone number.

Insert Validation:
Required if cell area code exists.

Update Validation:
Required if cell area code exists.

NationalProducerCode optional xs:long

A numeric code that is being issued for all producers from the National Insurance Producer Registry to eliminate the sole dependency on using social security numbers as unique identifiers. This is being done as part of the effort to implement electronic appointments and terminations.

PagerAreaCode optional xs:string

Area code portion of the pager phone number.

PagerExtension optional xs:string

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

Employee1099Category optional xs:short

If the employee is paid on a 1099, the category of the 1099 form to be issued. See S1099 category info for more information.

Employee1099Type optional xs:short

If the employee is paid on a 1099, the type of the 1099 form within the 1099 category. See S1099 type info for more information.

ShortName optional xs:string

Unique identifier for an employee. This displayable code is entered and maintained by the agency.

State optional xs:string

State for employee address.

Code value from the "State" value list.

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

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=State

EmployeeStatus optional xs:string

Indicates the status of the employee.

Code value from the "EmployeeStatus" value list.
Valid values are:
A = Active
I = Inactive
R = Retired
D = Deleted - Cannot be used during an Insert/Update operation

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=EmployeeStatus

EmployeeTitle optional xs:string

Title to be used when writing a salutation to the employee.

TimeZone optional xs:short

Time zone code for the time zone in which the employee resides.

Code value from the "TimeZone" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=TimeZone

YearEmployed optional xs:string

Year the employee started work.

ZipCode optional xs:string

Zip/postal code for employee address.

Other optional xs:boolean

BusinessUnitList optional ArrayOfBusinessUnit Complex Type

Collection of BusinessUnit types for the employee.

Sequence

BusinessUnit 0..∞ BusinessUnit Complex Type

Sequence

GLDivisionCode optional xs:string

GLBranchCode optional xs:string

GLDepartmentCode optional xs:string

GLGroupCode optional xs:string

Used By

EmployeeGetByCodeResult Element
EmployeeGetByCodeResponse Element (https://wsapi.ams360.com/v3.0/DataContract)

Source

<xs:complexType name="EmployeeGetByCodeResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Response object containing a single employee entity having the requested code.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="Employee" nillable="true" type="tns:EmployeeWithBusinessUnits" />
  </xs:sequence>
</xs:complexType>