POST v1/Policy/Rewrite?PolicyNumber={PolicyNumber}&Term={Term}&Note={Note}
Rewrite
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PolicyNumber | string |
Required |
|
Term |
Policy term |
PolicyTermEnum |
Default value is Current |
Note | string |
None. |
Body Parameters
Policy data to use for rewrite
PolicyProductInboundDTOName | Description | Type | Additional information |
---|---|---|---|
Policy | PolicyInboundDTO |
Required |
|
Product | Object |
Required |
|
Id |
Primary Id |
integer |
None. |
Expand |
Comma separated list of expansions to include in results |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Policy": { "EffectiveDate": "2024-10-11T22:59:54.2105024-10:00", "ExpirationDate": "2024-10-11T22:59:54.2105024-10:00", "PolicyNumber": "sample string 1", "UnderlyingPolicyNumber": "sample string 2", "BillPlanId": 1, "ThirdPartyBillTypeId": 1, "RenewalBillPlanId": 1, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "BillingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "NamedInsuredLegalStatus": "Unknown", "RateGuaranteeDate": "2024-10-11T22:59:54.2105024-10:00", "RatingTaxa": "sample string 3", "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "ProcessorId": 1, "DivisionOrganizationId": 1, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "AdditionalParties": [ { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "BillingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "BillingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 } ], "TermNumber": 4, "Status": "Unknown", "Id": 5, "Expand": "" }, "Product": {}, "Id": 2, "Expand": "" }
application/xml, text/xml
Sample:
<PolicyProductInboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound"> <Expand></Expand> <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <Id>2</Id> <Policy> <Expand></Expand> <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <Id>5</Id> <AdditionalParties xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:PolicyEntityDTO> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>7</d3p1:Id> <d3p1:BillingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:BillingAddress> <d3p1:CommercialName>sample string 3</d3p1:CommercialName> <d3p1:EmailAddress>sample string 4</d3p1:EmailAddress> <d3p1:FirstName>sample string 1</d3p1:FirstName> <d3p1:HomePhone>sample string 5</d3p1:HomePhone> <d3p1:LastName>sample string 2</d3p1:LastName> <d3p1:MailingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:MailingAddress> <d3p1:MobilePhone>sample string 6</d3p1:MobilePhone> <d3p1:RiskAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:RiskAddress> <d3p1:RiskAddressIsMailingAddress>true</d3p1:RiskAddressIsMailingAddress> <d3p1:Type>Unknown</d3p1:Type> </d3p1:PolicyEntityDTO> <d3p1:PolicyEntityDTO> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>7</d3p1:Id> <d3p1:BillingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:BillingAddress> <d3p1:CommercialName>sample string 3</d3p1:CommercialName> <d3p1:EmailAddress>sample string 4</d3p1:EmailAddress> <d3p1:FirstName>sample string 1</d3p1:FirstName> <d3p1:HomePhone>sample string 5</d3p1:HomePhone> <d3p1:LastName>sample string 2</d3p1:LastName> <d3p1:MailingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:MailingAddress> <d3p1:MobilePhone>sample string 6</d3p1:MobilePhone> <d3p1:RiskAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:RiskAddress> <d3p1:RiskAddressIsMailingAddress>true</d3p1:RiskAddressIsMailingAddress> <d3p1:Type>Unknown</d3p1:Type> </d3p1:PolicyEntityDTO> </AdditionalParties> <AdditionalPayees xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:AdditionalPayeeDTO> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>1</d3p1:Id> <d3p1:CommissionOverride> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>2</d3p1:Id> <d3p1:CommissionOverride>true</d3p1:CommissionOverride> <d3p1:OverrideRate>1</d3p1:OverrideRate> <d3p1:OverrideType>Unknown</d3p1:OverrideType> <d3p1:Rate>1</d3p1:Rate> <d3p1:Type>Unknown</d3p1:Type> </d3p1:CommissionOverride> <d3p1:Type>Unknown</d3p1:Type> </d3p1:AdditionalPayeeDTO> <d3p1:AdditionalPayeeDTO> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>1</d3p1:Id> <d3p1:CommissionOverride> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>2</d3p1:Id> <d3p1:CommissionOverride>true</d3p1:CommissionOverride> <d3p1:OverrideRate>1</d3p1:OverrideRate> <d3p1:OverrideType>Unknown</d3p1:OverrideType> <d3p1:Rate>1</d3p1:Rate> <d3p1:Type>Unknown</d3p1:Type> </d3p1:CommissionOverride> <d3p1:Type>Unknown</d3p1:Type> </d3p1:AdditionalPayeeDTO> </AdditionalPayees> <AgencyCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>2</d3p1:Id> <d3p1:CommissionOverride>true</d3p1:CommissionOverride> <d3p1:OverrideRate>1</d3p1:OverrideRate> <d3p1:OverrideType>Unknown</d3p1:OverrideType> <d3p1:Rate>1</d3p1:Rate> <d3p1:Type>Unknown</d3p1:Type> </AgencyCommissionOverride> <AgencyId>1</AgencyId> <AgentCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>2</d3p1:Id> <d3p1:CommissionOverride>true</d3p1:CommissionOverride> <d3p1:OverrideRate>1</d3p1:OverrideRate> <d3p1:OverrideType>Unknown</d3p1:OverrideType> <d3p1:Rate>1</d3p1:Rate> <d3p1:Type>Unknown</d3p1:Type> </AgentCommissionOverride> <AgentId>1</AgentId> <BillPlanId>1</BillPlanId> <DivisionOrganizationId>1</DivisionOrganizationId> <EffectiveDate>2024-10-11T22:59:54.2105024-10:00</EffectiveDate> <ExpirationDate>2024-10-11T22:59:54.2105024-10:00</ExpirationDate> <NamedInsuredLegalStatus>Unknown</NamedInsuredLegalStatus> <PolicyNumber>sample string 1</PolicyNumber> <PrimaryNamedInsured xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>7</d3p1:Id> <d3p1:BillingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:BillingAddress> <d3p1:CommercialName>sample string 3</d3p1:CommercialName> <d3p1:EmailAddress>sample string 4</d3p1:EmailAddress> <d3p1:FirstName>sample string 1</d3p1:FirstName> <d3p1:HomePhone>sample string 5</d3p1:HomePhone> <d3p1:LastName>sample string 2</d3p1:LastName> <d3p1:MailingAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:MailingAddress> <d3p1:MobilePhone>sample string 6</d3p1:MobilePhone> <d3p1:RiskAddress> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>9</d3p1:Id> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 5</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1> <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2> <d3p1:Type>Unknown</d3p1:Type> </d3p1:RiskAddress> <d3p1:RiskAddressIsMailingAddress>true</d3p1:RiskAddressIsMailingAddress> <d3p1:Type>Unknown</d3p1:Type> </PrimaryNamedInsured> <ProcessorId>1</ProcessorId> <RateGuaranteeDate>2024-10-11T22:59:54.2105024-10:00</RateGuaranteeDate> <RatingTaxa>sample string 3</RatingTaxa> <RenewalBillPlanId>1</RenewalBillPlanId> <Status>Unknown</Status> <SubagencyCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models"> <d3p1:Expand></d3p1:Expand> <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d3p1:Id>2</d3p1:Id> <d3p1:CommissionOverride>true</d3p1:CommissionOverride> <d3p1:OverrideRate>1</d3p1:OverrideRate> <d3p1:OverrideType>Unknown</d3p1:OverrideType> <d3p1:Rate>1</d3p1:Rate> <d3p1:Type>Unknown</d3p1:Type> </SubagencyCommissionOverride> <SubagencyId>1</SubagencyId> <TermNumber>4</TermNumber> <ThirdPartyBillTypeId>1</ThirdPartyBillTypeId> <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber> </Policy> <Product /> </PolicyProductInboundDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SimplePolicyResponseDTOName | Description | Type | Additional information |
---|---|---|---|
PolicyId | integer |
None. |
|
ProductId | integer |
None. |
|
PolicyNumber | string |
None. |
|
UnderlyingPolicyNumber | string |
None. |
|
Premium | decimal number |
None. |
|
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "PolicyId": 1, "ProductId": 1, "PolicyNumber": "sample string 2", "UnderlyingPolicyNumber": "sample string 3", "Premium": 4.0 }
application/xml, text/xml
Sample:
<SimplePolicyResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>5</Id> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> <Premium>4</Premium> <ProductId>1</ProductId> <UnderlyingPolicyNumber>sample string 3</UnderlyingPolicyNumber> </SimplePolicyResponseDTO>