| Method | /v3/WSAPIService.svc/PolicyGet |
In This Topic
Description
Gets a policy entity from the agency database using Policy Id and Transaction Effective Date.
Request (WSAPIServiceContract_PolicyGet_InputMessage)
The request body is of type PolicyGet.
Request Body Parameters
| Name | Description | Data Type |
|---|
| Request | Message request object containing the policy id and transaction effective date for which to return data. | PolicyGetRequest |
Overview
 |
 |
Sequence
|
|
Sequence
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a policy. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
TransactionEffectiveDate optional xs:dateTime
Identifies an endorsement date for a Policy. If not specified, gets LineOfBusiness as of the last endorsement on the Policy and gets the list of all the PolicyTransactions.
If an endorsement date is specified, gets LineOfBusiness as of that date and gets the list of PolicyTransactions for that date. If the Policy has more than one change on a date, all changes for that date are returned. Date only (MM/DD/YYYY)
| | | | |
Response (WSAPIServiceContract_PolicyGet_OutputMessage)
The response body is of type PolicyGetResponse.
Response Body Parameters
| Name | Description | Data Type |
|---|
| PolicyGetResult | Message response object containing policy data matching the policy id and transaction date including additional line of business, policy personnel, and policy transaction data for the policy. | PolicyGetResponse |
Overview
|
|
Sequence
|
PolicyGetResult optional PolicyGetResponse Complex Type
Message response object containing policy data matching the policy id and transaction date including additional line of business, policy personnel, and policy transaction data for the policy.
|
Sequence
|
|
Sequence
|
CustomerId optional guid Simple Type
Globally Unique Identifier (GUID) for the customer. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a policy.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyId for the customer. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
PolicyNumber optional xs:string
Company assigned number used to identify a policy. If the agency does not have a number for a policy/application, they will assign a temporary number.
Insert Validation:
Policy Number should contain at least one alpha or numeric character.
Update Validation:
Policy Number should contain at least one alpha or numeric character.
|
|
TypeOfBusiness optional xs:short
Code value for the type of business this policy represents. Code value from the "TypeOfBusiness" value list. Valid values are:
0-All
1-Personal Lines
2-Commercial Lines
3-Non Property and Casualty
4-Benefits
5-Life
6-Health
7-Financial Services
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=TypeOfBusiness
|
|
PolicyType optional xs:string
Type of policy. Code value from the "PolicyType" value list. Valid values are:
B = BOP
M = Monoline
P = Package
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=PolicyType
|
|
PolicyTypeOfBusiness optional xs:string
Description for the type of policy.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
|
|
WritingCompanyCode optional xs:string
Parent or writing company representing who the policy is placed with. If you have both, use the writing company.
Insert Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode.
Update Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode. Changes to WritingCompanyCode will result in an update for all LineOfBusiness and PolicyTransactionPremium rows for the policy term(includes policy effective date, past, current and future endorsement dates). WritingCompanyCode can be updated when IsCorrection is True. If billed or suspended billing exists an error message is returned. Valid values are maintained in the Company entity.
|
|
AccountExecCode optional xs:string
The Account Executive or Producer assigned to the policy.
Insert Validation:
Must be a valid AMS360 EmployeeCode where IsProd='Y'.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
Use PolicyServicePersonnelModifyList to update personnel on the policy.
|
|
AccountRepCode optional xs:string
The Account Representative for the policy.
Insert Validation:
Must be a valid AMS360 EmployeeCode where IsRep='Y'.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
Use PolicyServicePersonnelModifyList to update personnel on the policy.
|
|
BrokerCode optional xs:string
Code representing the Broker assigned to the policy if the policy is written through a brokered agent.
Insert Validation:
This is a required field if the customer is a broker's customer.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
Use PolicyServicePersonnelModifyList to update personnel on the policy.
|
|
PolicyEffectiveDate optional xs:dateTime
The date the policy becomes effective.
Insert Validation:
The column is required for a policy. This date will always equal the EffDate of the first PolT record for this policy. Must be less then PolExpDate.
Update Validation:
Not available for update. This value is ignored and no error message is returned. When used in a PolicyCorrect then PolicyEffectiveDate can be updated. It must be no more than 1 day prior to the first policy TransactionEffectiveDate. Date value only (MM/DD/YYYY).
|
|
PolicyExpirationDate optional xs:dateTime
The date the policy expires.
Insert Validation:
Must be greater than or equal to the PolicyEffectiveDate. If set to null, IsContinuous must be set to True.
Update Validation:
Date must be greater (+1) than the greatest policy TransactionEffectiveDate. Update is not available if the policy has been Suspended (IsSuspended=Y) or if any of the policy Transaction rows came from download. Date value only (MM/DD/YYYY).
|
|
IsContinuous optional xs:boolean
Determines if the policy does not expire. If the policy is continuous, then the policy expiration date (PolicyExpirationDate) is set SQL_HIGHDATE.
Insert Validation:
If set to True; PolicyExpirationDate will be cleared and set to SQL_HIGHDATE.
Update Validation:
If set to True; PolicyExpirationDate will be cleared and set to SQL_HIGHDATE.
|
|
PolicyStatus optional xs:string
Indicates the status of a policy.
Insert Validation:
Set by AMS360 to "A" (Active).
Update Validation:
Set by AMS360 as follows:
If TransactionType = XLC (Cancellation) the original policy's PolicyStatus will be set to "C" (Cancelled)
If TransactionType = NRA (Non renewal) the flag will be set to "N" (Non-renewed)
If TransactionType = REI (Reinstatement) and the PolicyStatus is set to "C" (Cancelled) it will be changed and set to "A" (Active)
If TransactionType = RNR (Reversal of non renewal) and the PolicyStatus is set to "N" (Non-renewed) it will be changed and set to "A" (Active)
Code value from the "PolicyStatus" value list.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=PolicyStatus
|
|
GLDivisionCode optional xs:string
Business unit division for this policy.
Insert Validation:
Must be a valid code in GeneralLedgerDivision table. If null is sent, AMS360 sets the division to the GLDivisionCode on the customer's entity.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Valid values are maintained in the General Ledger Division entity.
|
|
GLDepartmentCode optional xs:string
Business unit department for this policy.
Insert Validation:
Must be a valid GLDepartmentCode for the identified Branch. If null is sent, AMS360 sets the department to the GLDepartmentCode on the customer's entity.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Valid values are maintained in the General Ledger Department entity.
|
|
GLBranchCode optional xs:string
Business unit branch for this policy.
Insert Validation:
Must be a valid GLBranchCode for the identified Division. If null is sent, AMS360 sets the branch to GLBranchCode on the customer's entity.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Valid values are maintained in the General Ledger Branch entity.
|
|
GLGroupCode optional xs:string
Business unit group for this policy.
Insert Validation:
Must be a valid GLGroupCode for the identified Department. If null is sent, AMS360 sets the group to the GLGroupCode on the customer's entity.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Valid values are maintained in the General Ledger Group entity.
|
|
BillMethod optional xs:string
The method of billing used. Code value from the "BillMethod" value list. Valid values are:
A = Agency,
P = Direct.
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=BillMethod
|
|
IsNewPolicy optional xs:boolean
Indicates if business is new to the agency.
|
|
FullTermPremium optional xs:decimal
Policy premium amount charged for the term of the policy.
Insert Validation:
If amount not sent, AMS360 sets to 0.00. Formatted as: 99999999999.99
|
|
IsFinanced optional xs:boolean
Indicates whether or not a policy's premium has been financed.
|
|
CompanyType optional xs:string
Type of company selected to choose a parent and writing company for the policy. Subscription is not available for Company Type.
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.
|
|
IsMultiEntity optional xs:boolean
Master/MultipleEntities Customer has a multiple entity policy with sub-customers (companies/people) that are insured by the master policy. Master/MultipleEntities Policy receivables can be tracked at the Sub-Customer Level or Master Customer Level.
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.
|
|
PolicySubType optional xs:string
Defines if the entry is an accounting policy, submission, or insurance policy.
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 = Accounting
S = Submission
P = Policy
|
|
Description optional xs:string
Allows for additional information regarding the policy.
|
|
|
Sequence
|
|
Sequence
|
LineOfBusinessId optional guid Simple Type
Globally Unique Identifier (GUID) for this line of business.
Insert Validation:
AMS360 sproc inserts.
Update Validation:
Required if updating an existing line of business. Must be a valid AMS360 LineOfBusinessId for the given PolicyId. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
PolicyLineOfBusiness optional xs:string
Identifies the line of business code for this policy.
Insert Validation:
Must be a valid line of business code.
Update Validation:
Must be a valid line of business code. Valid values are maintained in the Line of business entity.
|
|
SortOrderNumber optional xs:short
Identifies the order the lines of business are displayed.
Insert Validation:
If null sent, AMS360 sets to the next available sequential number.
Update Validation:
If null sent, AMS360 sets to the next available sequential number.
| | | | |
|
|
Sequence
|
|
Sequence
|
EmployeeCode optional xs:string
Identifies other personnel that may be involved with the servicing or writing the policy.
Insert Validation:
Must be a valid employee code.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Valid values are maintained in the employee entity.
|
|
EmployeeType optional xs:string
Employees interest in the policy.
Insert Validation:
For the given EmployeeCode and EmployeeType the employee must be setup in AMS360 as either an AccountRep, AccountExec or SalesCenterRep.
Update Validation:
Not available for update. This value is ignored and no error message is returned. Code value from the "PolicyPersonnelEmpType" value list.
Valid values are:
P = Producer/Account Executive
R = Account Representative
T = Sales Center Representative
B = Broker
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=PolicyPersonnelEmpType
|
|
IsPrimary optional xs:boolean
Indicates if the Account Exec, Account Rep, and/or Broker is primary for the policy. If the value is not provided or is null, default is true.
|
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a policy.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyId for the customer. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
PolicyPersonnelId optional guid Simple Type
Globally Unique Identifier (GUID) for an individual personnel assignment to a policy.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyPersonnelId for the policy. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
| | | | |
|
|
Sequence
|
|
Sequence
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a policy.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyId for the customer. 36 alpha-numeric column, formatted as: 00000000-0000-0000-0000-000000000000
|
|
TransactionType optional xs:string
A code representing the type of policy action this transaction was initiated for. Code value from the "TransactionType" 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 ValueListGet() method.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=TransactionType
|
|
TransactionReasonCode optional xs:string
Identifies the reason for the transaction. If a description is not provided the policy action will be used as the description. See PolicyTransaction, TransactionType for the valid policy action code description. Code value from the "TransactionReasonCode" value list.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=TransactionReasonCode
|
|
TransactionDescription optional xs:string
If a description is not provided the policy action will be used as the description. See PolicyTransaction, TransactionType for the valid policy action code description.
|
|
BillMethod optional xs:string
The method of billing used. Code value from the "BillMethod" value list. A = Agency, P = Direct.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=BillMethod
| | | | |
|
|
Sequence
|
|
Sequence
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a Policy. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000.
|
|
TransactionEffectiveDate optional xs:dateTime
Identifies the Policy Transaction (endorsement) for the Policy that the PolicyTransactionPremium belongs to. 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'
|
|
PolicyTransactionPremiumId optional guid Simple Type
Globally Unique Identifier (GUID) for a PolicyTransactionPremium.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyTransctionPremiumId for the Policy and PolicyTransaction. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000.
|
|
LineOfBusiness optional xs:string
Identifies the line of business for this PolicyTransactionPremium.
Insert Validation:
Must be a valid LineOfBusiness for the Policy's TypeOfBusiness.
Update Validation:
Must be a valid LineOfBusiness for the Policy's TypeOfBusiness. Changes to this value are ignored during updates to previously billed PolicyTransactionPremium rows and no error message is returned. Valid AMS360 Line of Business codes.
|
|
PlanType optional xs:string
Identifies the program or plan for this PolicyTransactionPremium. Must be an existing program or plan that was setup in AMS360 for the Policy's insurance company.
Insert Validation:
PlanType must be a active plan type in the system and also active for the Policy's insurance company.
Update Validation:
PlanType must be a active plan type in the system and also active for the Policy's insurance company. Changes to this value are ignored during updates to previously billed PolicyTransactionPremium rows and no error message is returned.
|
|
WritingCompanyCode optional xs:string
Identifies the company for this PolicyTransactionPremium.
Insert Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode.
Update Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode. If WritingCompanyCode change is done by UpdatePolicy, on an unbilled policy, all PolicyTransactionPremium rows for the policy term(includes policy effective date, past, current, and future endorsement dates) will be updated with the new WritingCompanyCode. Changes to this field are ignored during updates to previously billed PolicyTransactionPremium rows and no error message will be returned.
|
|
Description optional xs:string
Description for this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the description will default to the LineOfBusiness description.
Update Validation:
Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
Premium optional xs:decimal
The premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
WrittenPremium optional xs:decimal
The written premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
FullTermPremium optional xs:decimal
The full term premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
IncludePremium optional xs:boolean
Indicates if the premium values on this PolicyTransactionPremium should be included in policy totals.
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.
|
|
HowBilled optional xs:string
Value indicates how this PolicyTransactionPremium will be treated for billing purposes.
Insert Validation:
Agency Bill policies are restricted to use either Customer Center Billing ('C') or Not Billed ('N'). Direct Billed policies may use any HowBilled list value.
Update Validation:
Agency Bill policies are restricted to use either Customer Center Billing ('C') or Not Billed ('N'). Direct Billed policies may use any HowBilled list value. Changes to this field are ignored during updates to posted (previously bill) PolicyTransactionPremium rows and no error message is returned. Valid code values from the "HowBilled" name 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 ValueListGet() method.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=HowBilled
|
|
IsSuspended optional xs:boolean
System maintained value indicating if this PolicyTransactionPremium is in the process of being billed (invoiced).
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.
|
|
Reconciled optional xs:string
System maintained field used for DirectBillStatement PolicyTransactionPremiums to indicate whether or not they have been completely reconciled on a Direct Bill Statement.
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. If HowBilled is DirectBillStatement the value will be 'N' or 'Y'; If HowBilled is anything else, the value will be 'D'
|
| | | |
|
PolicyNotationId optional guid Simple Type
Agency defined value which represents the policy's/submission's status or special notation. Code value from the "PolicyNotation" 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 ValueListGet() method.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=PolicyNotation
|
|
PriorPolicy optional xs:string
Prior policy number for a renewed policy.
|
|
PriorPolicyId optional guid Simple Type
Prior PolicyId for a renewed or rewritten policy. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000
|
|
SourcePolicyId optional guid Simple Type
Source PolicyId of the original policy. Will be null if a submission, new policy from a submission, or a new policy. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000
|
|
IsExcludeDelete optional xs:boolean
To flag a policy so it cannot be deleted.
|
|
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.
|
| | | | | |
Fault Responses
| Fault | Description |
|---|
| WSAPISecurityFaultFault | This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PolicyGet_WSAPISecurityFaultFault_FaultMessage. |
| WSAPIBusinessFaultFault | This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PolicyGet_WSAPIBusinessFaultFault_FaultMessage. |
| WSAPIGeneralFaultFault | This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_PolicyGet_WSAPIGeneralFaultFault_FaultMessage. |
See Also
