PUT v1/Policies

Insert a pending policy into Catalyst

Request Information

URI Parameters

None.

Body Parameters

Policy quote info

Name	Type	Additional information
Term	string	None.
PolicyType	string	None.
PackageType	string	None.
PackageLobIDs	Collection of integer	None.
CSRId	integer	None.
AgentId	integer	None.
PolicySourceID	integer	None.
PolicySourceDetails	string	None.
Producers	Collection of PolicyQuoteProducerDTO	None.
PolicyId	integer	None.
CustomerId	integer	None.
PolicyNumber	string	None.
EffectiveDate	string	None.
ExpirationDate	string	None.
Status	string	None.
TotalPremium	decimal number	None.
Description	string	None.
LOBId	integer	None.
MGAId	integer	None.
CarrierId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Term": "sample string 1",
  "PolicyType": "sample string 2",
  "PackageType": "sample string 3",
  "PackageLobIDs": [
    1,
    2
  ],
  "CSRId": 1,
  "AgentId": 1,
  "PolicySourceID": 1,
  "PolicySourceDetails": "sample string 4",
  "Producers": [
    {
      "PolicyQuoteID": 1,
      "ProducerID": 2,
      "id": 3,
      "AgencyFeesCommissions": [
        {
          "PolicyQuoteID": 1,
          "AgencyFeeID": 2,
          "ProducerID": 3,
          "CommissionableAmount": 4.0,
          "Amount": 5.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 7.0,
          "ID": 8,
          "AdjustmentID": 1,
          "UtilityAgencyFee": {
            "DefaultAmount": 1.0,
            "AmountIsPercent": true,
            "Visible": true,
            "LocationID": 1,
            "ShowInInvoice": true,
            "FeeType": 1,
            "AgencyFeeID": 3,
            "AgencyFeeName": "sample string 4"
          }
        },
        {
          "PolicyQuoteID": 1,
          "AgencyFeeID": 2,
          "ProducerID": 3,
          "CommissionableAmount": 4.0,
          "Amount": 5.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 7.0,
          "ID": 8,
          "AdjustmentID": 1,
          "UtilityAgencyFee": {
            "DefaultAmount": 1.0,
            "AmountIsPercent": true,
            "Visible": true,
            "LocationID": 1,
            "ShowInInvoice": true,
            "FeeType": 1,
            "AgencyFeeID": 3,
            "AgencyFeeName": "sample string 4"
          }
        }
      ],
      "PolicyCommissions": [
        {
          "ID": 1,
          "PolicyQuoteID": 2,
          "ProducerID": 1,
          "CommissionablePremium": 1.0,
          "Amount": 1.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 4.0,
          "RuleFor": "sample string 5",
          "EndorseID": 1,
          "CommissionType": "sample string 6",
          "Producer": "sample string 7"
        },
        {
          "ID": 1,
          "PolicyQuoteID": 2,
          "ProducerID": 1,
          "CommissionablePremium": 1.0,
          "Amount": 1.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 4.0,
          "RuleFor": "sample string 5",
          "EndorseID": 1,
          "CommissionType": "sample string 6",
          "Producer": "sample string 7"
        }
      ]
    },
    {
      "PolicyQuoteID": 1,
      "ProducerID": 2,
      "id": 3,
      "AgencyFeesCommissions": [
        {
          "PolicyQuoteID": 1,
          "AgencyFeeID": 2,
          "ProducerID": 3,
          "CommissionableAmount": 4.0,
          "Amount": 5.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 7.0,
          "ID": 8,
          "AdjustmentID": 1,
          "UtilityAgencyFee": {
            "DefaultAmount": 1.0,
            "AmountIsPercent": true,
            "Visible": true,
            "LocationID": 1,
            "ShowInInvoice": true,
            "FeeType": 1,
            "AgencyFeeID": 3,
            "AgencyFeeName": "sample string 4"
          }
        },
        {
          "PolicyQuoteID": 1,
          "AgencyFeeID": 2,
          "ProducerID": 3,
          "CommissionableAmount": 4.0,
          "Amount": 5.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 7.0,
          "ID": 8,
          "AdjustmentID": 1,
          "UtilityAgencyFee": {
            "DefaultAmount": 1.0,
            "AmountIsPercent": true,
            "Visible": true,
            "LocationID": 1,
            "ShowInInvoice": true,
            "FeeType": 1,
            "AgencyFeeID": 3,
            "AgencyFeeName": "sample string 4"
          }
        }
      ],
      "PolicyCommissions": [
        {
          "ID": 1,
          "PolicyQuoteID": 2,
          "ProducerID": 1,
          "CommissionablePremium": 1.0,
          "Amount": 1.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 4.0,
          "RuleFor": "sample string 5",
          "EndorseID": 1,
          "CommissionType": "sample string 6",
          "Producer": "sample string 7"
        },
        {
          "ID": 1,
          "PolicyQuoteID": 2,
          "ProducerID": 1,
          "CommissionablePremium": 1.0,
          "Amount": 1.0,
          "AmountIsPercent": true,
          "CalculatedAmount": 4.0,
          "RuleFor": "sample string 5",
          "EndorseID": 1,
          "CommissionType": "sample string 6",
          "Producer": "sample string 7"
        }
      ]
    }
  ],
  "PolicyId": 1,
  "CustomerId": 5,
  "PolicyNumber": "sample string 6",
  "EffectiveDate": "sample string 7",
  "ExpirationDate": "sample string 8",
  "Status": "sample string 9",
  "TotalPremium": 10.0,
  "Description": "sample string 11",
  "LOBId": 12,
  "MGAId": 1,
  "CarrierId": 1
}

application/xml, text/xml

Sample:

<InsertPolicyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <CarrierId>1</CarrierId>
  <CustomerId>5</CustomerId>
  <Description>sample string 11</Description>
  <EffectiveDate>sample string 7</EffectiveDate>
  <ExpirationDate>sample string 8</ExpirationDate>
  <LOBId>12</LOBId>
  <MGAId>1</MGAId>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 6</PolicyNumber>
  <Status>sample string 9</Status>
  <TotalPremium>10</TotalPremium>
  <AgentId>1</AgentId>
  <CSRId>1</CSRId>
  <PackageLobIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>1</d2p1:short>
    <d2p1:short>2</d2p1:short>
  </PackageLobIDs>
  <PackageType>sample string 3</PackageType>
  <PolicySourceDetails>sample string 4</PolicySourceDetails>
  <PolicySourceID>1</PolicySourceID>
  <PolicyType>sample string 2</PolicyType>
  <Producers>
    <PolicyQuoteProducerDTO>
      <AgencyFeesCommissions>
        <PolicyAgencyFeesProducerDTO>
          <AdjustmentID>1</AdjustmentID>
          <AgencyFeeID>2</AgencyFeeID>
          <Amount>5</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>7</CalculatedAmount>
          <CommissionableAmount>4</CommissionableAmount>
          <ID>8</ID>
          <PolicyQuoteID>1</PolicyQuoteID>
          <ProducerID>3</ProducerID>
          <UtilityAgencyFee>
            <AgencyFeeID>3</AgencyFeeID>
            <AgencyFeeName>sample string 4</AgencyFeeName>
            <AmountIsPercent>true</AmountIsPercent>
            <DefaultAmount>1</DefaultAmount>
            <FeeType>1</FeeType>
            <LocationID>1</LocationID>
            <ShowInInvoice>true</ShowInInvoice>
            <Visible>true</Visible>
          </UtilityAgencyFee>
        </PolicyAgencyFeesProducerDTO>
        <PolicyAgencyFeesProducerDTO>
          <AdjustmentID>1</AdjustmentID>
          <AgencyFeeID>2</AgencyFeeID>
          <Amount>5</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>7</CalculatedAmount>
          <CommissionableAmount>4</CommissionableAmount>
          <ID>8</ID>
          <PolicyQuoteID>1</PolicyQuoteID>
          <ProducerID>3</ProducerID>
          <UtilityAgencyFee>
            <AgencyFeeID>3</AgencyFeeID>
            <AgencyFeeName>sample string 4</AgencyFeeName>
            <AmountIsPercent>true</AmountIsPercent>
            <DefaultAmount>1</DefaultAmount>
            <FeeType>1</FeeType>
            <LocationID>1</LocationID>
            <ShowInInvoice>true</ShowInInvoice>
            <Visible>true</Visible>
          </UtilityAgencyFee>
        </PolicyAgencyFeesProducerDTO>
      </AgencyFeesCommissions>
      <PolicyCommissions>
        <PolicyCommissionEntriesProducerDTO>
          <Amount>1</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>4</CalculatedAmount>
          <CommissionType>sample string 6</CommissionType>
          <CommissionablePremium>1</CommissionablePremium>
          <EndorseID>1</EndorseID>
          <ID>1</ID>
          <PolicyQuoteID>2</PolicyQuoteID>
          <Producer>sample string 7</Producer>
          <ProducerID>1</ProducerID>
          <RuleFor>sample string 5</RuleFor>
        </PolicyCommissionEntriesProducerDTO>
        <PolicyCommissionEntriesProducerDTO>
          <Amount>1</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>4</CalculatedAmount>
          <CommissionType>sample string 6</CommissionType>
          <CommissionablePremium>1</CommissionablePremium>
          <EndorseID>1</EndorseID>
          <ID>1</ID>
          <PolicyQuoteID>2</PolicyQuoteID>
          <Producer>sample string 7</Producer>
          <ProducerID>1</ProducerID>
          <RuleFor>sample string 5</RuleFor>
        </PolicyCommissionEntriesProducerDTO>
      </PolicyCommissions>
      <PolicyQuoteID>1</PolicyQuoteID>
      <ProducerID>2</ProducerID>
      <id>3</id>
    </PolicyQuoteProducerDTO>
    <PolicyQuoteProducerDTO>
      <AgencyFeesCommissions>
        <PolicyAgencyFeesProducerDTO>
          <AdjustmentID>1</AdjustmentID>
          <AgencyFeeID>2</AgencyFeeID>
          <Amount>5</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>7</CalculatedAmount>
          <CommissionableAmount>4</CommissionableAmount>
          <ID>8</ID>
          <PolicyQuoteID>1</PolicyQuoteID>
          <ProducerID>3</ProducerID>
          <UtilityAgencyFee>
            <AgencyFeeID>3</AgencyFeeID>
            <AgencyFeeName>sample string 4</AgencyFeeName>
            <AmountIsPercent>true</AmountIsPercent>
            <DefaultAmount>1</DefaultAmount>
            <FeeType>1</FeeType>
            <LocationID>1</LocationID>
            <ShowInInvoice>true</ShowInInvoice>
            <Visible>true</Visible>
          </UtilityAgencyFee>
        </PolicyAgencyFeesProducerDTO>
        <PolicyAgencyFeesProducerDTO>
          <AdjustmentID>1</AdjustmentID>
          <AgencyFeeID>2</AgencyFeeID>
          <Amount>5</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>7</CalculatedAmount>
          <CommissionableAmount>4</CommissionableAmount>
          <ID>8</ID>
          <PolicyQuoteID>1</PolicyQuoteID>
          <ProducerID>3</ProducerID>
          <UtilityAgencyFee>
            <AgencyFeeID>3</AgencyFeeID>
            <AgencyFeeName>sample string 4</AgencyFeeName>
            <AmountIsPercent>true</AmountIsPercent>
            <DefaultAmount>1</DefaultAmount>
            <FeeType>1</FeeType>
            <LocationID>1</LocationID>
            <ShowInInvoice>true</ShowInInvoice>
            <Visible>true</Visible>
          </UtilityAgencyFee>
        </PolicyAgencyFeesProducerDTO>
      </AgencyFeesCommissions>
      <PolicyCommissions>
        <PolicyCommissionEntriesProducerDTO>
          <Amount>1</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>4</CalculatedAmount>
          <CommissionType>sample string 6</CommissionType>
          <CommissionablePremium>1</CommissionablePremium>
          <EndorseID>1</EndorseID>
          <ID>1</ID>
          <PolicyQuoteID>2</PolicyQuoteID>
          <Producer>sample string 7</Producer>
          <ProducerID>1</ProducerID>
          <RuleFor>sample string 5</RuleFor>
        </PolicyCommissionEntriesProducerDTO>
        <PolicyCommissionEntriesProducerDTO>
          <Amount>1</Amount>
          <AmountIsPercent>true</AmountIsPercent>
          <CalculatedAmount>4</CalculatedAmount>
          <CommissionType>sample string 6</CommissionType>
          <CommissionablePremium>1</CommissionablePremium>
          <EndorseID>1</EndorseID>
          <ID>1</ID>
          <PolicyQuoteID>2</PolicyQuoteID>
          <Producer>sample string 7</Producer>
          <ProducerID>1</ProducerID>
          <RuleFor>sample string 5</RuleFor>
        </PolicyCommissionEntriesProducerDTO>
      </PolicyCommissions>
      <PolicyQuoteID>1</PolicyQuoteID>
      <ProducerID>2</ProducerID>
      <id>3</id>
    </PolicyQuoteProducerDTO>
  </Producers>
  <Term>sample string 1</Term>
</InsertPolicyDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InsertPolicyDTO'.

Response Information

Resource Description

Inserting result

ActionResultDTOOfString

Name	Type	Additional information
Result	string	None.
CreatedBy	string	None.
EntityID	integer	None.
RowSource	string	None.
PolicyID	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
InfoMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": "sample string 1",
  "CreatedBy": "sample string 2",
  "EntityID": 3,
  "RowSource": "sample string 4",
  "PolicyID": 5,
  "IsSuccess": true,
  "ErrorCode": "sample string 7",
  "ErrorMessage": "sample string 8",
  "InfoMessage": "sample string 9"
}

application/xml, text/xml

Sample:

<ActionResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 7</ErrorCode>
  <ErrorMessage>sample string 8</ErrorMessage>
  <InfoMessage>sample string 9</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 2</CreatedBy>
  <EntityID>3</EntityID>
  <PolicyID>5</PolicyID>
  <Result>sample string 1</Result>
  <RowSource>sample string 4</RowSource>
</ActionResultOfstring>