API Library

DRC’s solutions include a number of application programming interfaces (API) that are available right out of the box.

DRC's API Library includes restful services for:

  • Get Current User ID
  • Update User
  • Activate a User
  • Deactivate a User
  • List Customers
  • Get Customer Details
  • New Customer Save
  • Edit Customer
  • Get Customers Quotes
  • Get Agent Details
  • Create Agent
  • Update Agent
  • Activate Agent
  • Deactivate Agent
  • Get Payment History
  • Get Payment Plan
  • Get Payment Installment Schedule
  • Get autopay info
  • Get Bill History
  • Disable Auto Payment
  • Update Credit Card Payment
  • Update EFT Auto Payment
  • Post Payment
  • Assign and return policy number for early cash quote
  • Get policy number by APN
  • Get quote number by APN number
  • Get Policy by Filter
  • Get Policy Number
  • Get Policy Number
  • Cancel Policy
  • Add Do Not Reinstate Policy
  • Remove Do Not Reinstate from Policy
  • Rewrite a Policy
  • Create New Policy
  • Update Existing Policy
  • Partially Update Existing Policy
  • Get Quote via Search
  • Get Quote by Quote Number
  • Get Quote Status by Quote Number
  • Create New Quote
  • Partially Update Existing Quote
  • Update Existing Quote
  • Convert Quote to Policy
  • Resources

GET V1/USERS/GETCURRENTUSERID

Get current user id

REQUEST INFORMATION

URI PARAMETERS

Name Description Type Additional information
id User Id integer Required

BODY PARAMETERS

Updated user info

Name Description Type Additional information
username User’s username string Max length: 100
Password User’s password string None.
AgentId Agent Id if user is an agent integer None.
Id Primary Id

REQUESTS FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

APPLICATION/JSON, TEXT/JSON

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

RESPONSE INFORMATION

userDto

Name Description Type Additional information
username User’s username string Max length: 100
Password User’s password string None.
AgentId Agent Id if user is an agent integer None.
Id Primary Id integer None.

RESPONSE FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

APPLICATION/XML, TEXT/XML

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

POST V1/USERS/{ID}

Update an existing user by Id

REQUEST INFORMATION

URI PARAMETERS

Name Description Type Additional information
id User Id integer Required

BODY PARAMETERS

Updated user info

userDto

Name Description Type Additional information
Username User’s username string Max length: 100
Password User’s password string None.
AgentId Agent Id if user is an agent integer None.
Id Primary Id integer None.

REQUEST FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

APPLICATION/XML, TEXT/XML

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

APPLICATION/XML, TEXT/XML

Sample:

<userDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
<agentID>4</agentID>
<password>sample string 3</password>
<userID>1</userID>
<userName>sample string 2</userName>
</userDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

userDto

Name Description Type Additional information
Username User’s username string Max length: 100
Password User’s password string None.
AgentId Agent Id if user is an agent integer None.
Id Primary Id integer None.

RESPONSE FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

APPLICATION/XML, TEXT/XML

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

UT v1/Users/Activate/{id}

Activate a user by Id

Request Information

URI Parameters

Name Description Type Additional information
id User Id integer Required

Body Parameters

None.

Response Information

Resource Description

200 Ok on success

Name Description Type Additional information
Username User’s username string Max length: 100
Password User’s password string None.
AgentId AgentId if user is an agent integer None.
Id Primary Id integer None.

Response Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

application/xml, text/xml

Sample:
<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

PUT v1/Users/Deactivate/{id}

Deactivate a user by Id

Request Information

URI Parameters

Name Description Type Additional information
id User Id integer Required

Body Parameters

None.

Response Information

Resource Description

200 Ok on success

Name Description Type Additional information
Username User’s username string Max length: 100
Password User’s password string None.
AgentId Agent Id if user is an agent integer None.
Id Primary Id integer None.

Response Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "Id": 3
}

application/xml, text/xml

Sample:
<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>3</Id>
  <AgentId>1</AgentId>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserDTO>

GET v1/Customers?FirstName={FirstName}&LastName={LastName}&CommercialName={CommercialName}&CustomerId={CustomerId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Retrieves customers satistfying the filter criteria.

REQUEST INFORMATION

URI PARAMETERS

Name Description Type Additional information
FirstName string Max length: 30
LastName string Max length: 30
CommercialName string Max length: 50
CustomerId string None.
Limit Maximum number of records to return integer Range: inclusive between 1 and 2147483647
Offset Number of records to skip during search, useful for pagination integer Range: inclusive between 0 and 2147483647
Total Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. boolean None.
SortDirection Direction of sort: Ascending or Descending SortDirection None
Sort Comma separated list of field names to sort by string None
Expand Comma separated list of expansions to include in results string None

BODY PARAMETERS

None.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

List of customers

customerListDto

Name Description Type Additional information
Limit Echoed limit of request integer None.
Offset Echoed offset of request boolean None.
Total Total records matching search, if requested integer None.
Data List of records matching the search Collection of CustomerOutboundDTO None.

RESPONSE FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:
{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "FirstName": "sample string 1",
      "Id": 2,
      "LastName": "sample string 3",
      "CommercialName": "sample string 4",
      "Type": "Unknown",
      "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
      },
      "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
      },
      "MobilePhone": "sample string 5",
      "HomePhone": "sample string 6",
      "Quotes": [
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2019-04-08T09:18:15.6880395-10:00",
          "ExpirationDate": "2019-04-08T09:18:15.6880395-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 3",
          "PolicyNumber": "sample string 4",
          "Premium": 1.0,
          "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
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 5",
          "RateGuaranteeDate": "2019-04-08T09:18:15.6890677-10:00",
          "RatingTaxa": "sample string 6",
          "State": "sample string 7",
          "Country": "sample string 8",
          "UnderwritingCompanyId": 9,
          "UniversalAccountId": 10,
          "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
          },
          "Id": 11
        },
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2019-04-08T09:18:15.6880395-10:00",
          "ExpirationDate": "2019-04-08T09:18:15.6880395-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 3",
          "PolicyNumber": "sample string 4",
          "Premium": 1.0,
          "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
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 5",
          "RateGuaranteeDate": "2019-04-08T09:18:15.6890677-10:00",
          "RatingTaxa": "sample string 6",
          "State": "sample string 7",
          "Country": "sample string 8",
          "UnderwritingCompanyId": 9,
          "UniversalAccountId": 10,
          "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
          },
          "Id": 11
        }
      ]
    },
    {
      "FirstName": "sample string 1",
      "Id": 2,
      "LastName": "sample string 3",
      "CommercialName": "sample string 4",
      "Type": "Unknown",
      "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
      },
      "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
      },
      "MobilePhone": "sample string 5",
      "HomePhone": "sample string 6",
      "Quotes": [
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2019-04-08T09:18:15.6880395-10:00",
          "ExpirationDate": "2019-04-08T09:18:15.6880395-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 3",
          "PolicyNumber": "sample string 4",
          "Premium": 1.0,
          "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
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 5",
          "RateGuaranteeDate": "2019-04-08T09:18:15.6890677-10:00",
          "RatingTaxa": "sample string 6",
          "State": "sample string 7",
          "Country": "sample string 8",
          "UnderwritingCompanyId": 9,
          "UniversalAccountId": 10,
          "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
          },
          "Id": 11
        },
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2019-04-08T09:18:15.6880395-10:00",
          "ExpirationDate": "2019-04-08T09:18:15.6880395-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 3",
          "PolicyNumber": "sample string 4",
          "Premium": 1.0,
          "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
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 5",
          "RateGuaranteeDate": "2019-04-08T09:18:15.6890677-10:00",
          "RatingTaxa": "sample string 6",
          "State": "sample string 7",
          "Country": "sample string 8",
          "UnderwritingCompanyId": 9,
          "UniversalAccountId": 10,
          "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
          },
          "Id": 11
        }
      ]
    }
  ]
}


APPLICATION/XML, TEXT/XML

Sample:
Sample not available

GET v1/Customers/{id}

Retrieves the details of a customer by customer Id

Request Information

URI Parameters

Name Description Type Additional information
id Customer Id integer Required

BODY PARAMETERS

None.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

Customer details

customerDto

Name Description Type Additional information
FirstName Customer first name string Max length: 30
Id Customer Id integer None.
LastName Customer last name string Max length: 30
CommercialName Customer commercial name string Max length: 500
Type Customer type (Personal / Commercial) CustomerTypeEnum None.
RiskAddress Customer risk address EntityAddressDTO None.
MailingAddress Customer mailing address EntityAddressDTO None.
MobilePhone Customer mobile phone string None.
HomePhone Customer home phone string Max length: 25
Quotes Customer’s existing quotes string None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

RESPONSE FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:
{
  "FirstName": "sample string 1",
  "Id": 2,
  "LastName": "sample string 3",
  "CommercialName": "sample string 4",
  "Type": "Unknown",
  "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
  },
  "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
  },
  "MobilePhone": "sample string 5",
  "HomePhone": "sample string 6",
  "Quotes": [
    {
      "AgencyId": 1,
      "AgentId": 1,
      "SubagencyId": 1,
      "BillPlanId": 1,
      "RenewalBillPlanId": 1,
      "CustomerId": 1,
      "CompleteQuote": true,
      "EffectiveDate": "2019-04-08T11:58:56.4778815-10:00",
      "ExpirationDate": "2019-04-08T11:58:56.4778815-10:00",
      "QuoteTerm": "Unknown",
      "LineOfBusiness": "sample string 3",
      "PolicyNumber": "sample string 4",
      "Premium": 1.0,
      "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
        },
        "Type": "Unknown",
        "Id": 7
      },
      "QuoteNumber": "sample string 5",
      "RateGuaranteeDate": "2019-04-08T11:58:56.4788795-10:00",
      "RatingTaxa": "sample string 6",
      "State": "sample string 7",
      "Country": "sample string 8",
      "UnderwritingCompanyId": 9,
      "UniversalAccountId": 10,
      "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
      },
      "Id": 11
    },
    {
      "AgencyId": 1,
      "AgentId": 1,
      "SubagencyId": 1,
      "BillPlanId": 1,
      "RenewalBillPlanId": 1,
      "CustomerId": 1,
      "CompleteQuote": true,
      "EffectiveDate": "2019-04-08T11:58:56.4778815-10:00",
      "ExpirationDate": "2019-04-08T11:58:56.4778815-10:00",
      "QuoteTerm": "Unknown",
      "LineOfBusiness": "sample string 3",
      "PolicyNumber": "sample string 4",
      "Premium": 1.0,
      "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
        },
        "Type": "Unknown",
        "Id": 7
      },
      "QuoteNumber": "sample string 5",
      "RateGuaranteeDate": "2019-04-08T11:58:56.4788795-10:00",
      "RatingTaxa": "sample string 6",
      "State": "sample string 7",
      "Country": "sample string 8",
      "UnderwritingCompanyId": 9,
      "UniversalAccountId": 10,
      "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
      },
      "Id": 11
    }
  ]
}

APPLICATION/XML, TEXT/XML

Sample:

Sample not available

POST V1/CUSTOMERS

Create Customer

REQUEST INFORMATION

URI PARAMETERS

None.

BODY PARAMETERS

CustomerInboundDTO

Name Description Type Additional information
FirstName Customer first name string Max length: 30
Id Customer Id integer None.
LastName Customer last name string Max length: 30
CommercialName Customer commercial name strinng Max length: 500
Type Customer type (Personal / Commercial) CustomerTypeEnum None.
RiskAddress Customer risk address EntityAddressDTO None.
MailingAddress Customer mailing address EntityAddressDTO None.
MobilePhone Customer mobile phone string Max length: 25
HomePhone Customer homephone string Max length: 25
Expand Comma separated list of expansions to include in results string None.

REQUEST FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:

{
  "FirstName": "sample string 1",
  "Id": 2,
  "LastName": "sample string 3",
  "CommercialName": "sample string 4",
  "Type": "Unknown",
  "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
  },
  "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
  },
  "MobilePhone": "sample string 5",
  "HomePhone": "sample string 6",
  "Expand": ""
}

APPLICATION/XML, TEXT/XML

Sample:
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 ‘customerDto’.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

Id (integer) of newly created customer, with Http Status Code 201 when created, 404 if not found or 400/500 with error details

integer

RESPONSE FORMATS

application/json, text/json

Sample:

<CustomerInboundDTO 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>
  <CommercialName>sample string 4</CommercialName>
  <FirstName>sample string 1</FirstName>
  <HomePhone>sample string 6</HomePhone>
  <LastName>sample string 3</LastName>
  <MailingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
    <d2p1:Expand></d2p1:Expand>
    <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <d2p1:Id>9</d2p1:Id>
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:County>sample string 5</d2p1:County>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zipcode1>sample string 7</d2p1:Zipcode1>
    <d2p1:Zipcode2>sample string 8</d2p1:Zipcode2>
    <d2p1:Type>Unknown</d2p1:Type>
  </MailingAddress>
  <MobilePhone>sample string 5</MobilePhone>
  <RiskAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
    <d2p1:Expand></d2p1:Expand>
    <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <d2p1:Id>9</d2p1:Id>
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:County>sample string 5</d2p1:County>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zipcode1>sample string 7</d2p1:Zipcode1>
    <d2p1:Zipcode2>sample string 8</d2p1:Zipcode2>
    <d2p1:Type>Unknown</d2p1:Type>
  </RiskAddress>
  <Type>Unknown</Type>
</CustomerInboundDTO>

APPLICATION/XML, TEXT/XML

Sample:
Sample not available

Response Information

Resource Description

Id (integer) of newly created customer, with Http Status Code 201 when created, 400/500 with error details

integer

Response Formats

application/json, text/json

Sample:

1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>

PUT V1/CUSTOMERS/{ID}

Update Customer

REQUEST INFORMATION

URI PARAMETERS

Name Description Type Additional information
id Customer id integer Required

BODY PARAMETERS

customerDto

Name Description Type Additional information
FirstName Customer first name string Max length: 30
Id Customer Id integer None.
LastName Customer last name string Max length: 30
CommercialName Customer commercial name string None.
Type Customer type (Personal / Commercial) CustomerTypeEnum None.
RiskAddress Customer risk address EntityAddressDTO None.
MailingAddress Customer mailing address EntityAddressDTO None.
MobilePhone Customer mobile phone string Max length: 25
HomePhone Customer home phone string Max length: 25
Expand Comma separated list of expansions to include in results string None.

REQUEST FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:
{
  "FirstName": "sample string 1",
  "Id": 2,
  "LastName": "sample string 3",
  "CommercialName": "sample string 4",
  "Type": "Unknown",
  "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
  },
  "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
  },
  "MobilePhone": "sample string 5",
  "HomePhone": "sample string 6",
  "Expand": ""
}

APPLICATION/XML, TEXT/XML

Sample:
<CustomerInboundDTO 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>
  <CommercialName>sample string 4</CommercialName>
  <FirstName>sample string 1</FirstName>
  <HomePhone>sample string 6</HomePhone>
  <LastName>sample string 3</LastName>
  <MailingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
    <d2p1:Expand></d2p1:Expand>
    <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <d2p1:Id>9</d2p1:Id>
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:County>sample string 5</d2p1:County>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zipcode1>sample string 7</d2p1:Zipcode1>
    <d2p1:Zipcode2>sample string 8</d2p1:Zipcode2>
    <d2p1:Type>Unknown</d2p1:Type>
  </MailingAddress>
  <MobilePhone>sample string 5</MobilePhone>
  <RiskAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
    <d2p1:Expand></d2p1:Expand>
    <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <d2p1:Id>9</d2p1:Id>
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:County>sample string 5</d2p1:County>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zipcode1>sample string 7</d2p1:Zipcode1>
    <d2p1:Zipcode2>sample string 8</d2p1:Zipcode2>
    <d2p1:Type>Unknown</d2p1:Type>
  </RiskAddress>
  <Type>Unknown</Type>
</CustomerInboundDTO>

APPLICATION/X-WWW-FORM-URLENCODED

Sample:

Sample not available.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

Http Status Code 200 when success, 404 if not found or 500 with error details

Response Formats

application/json, text/json, application/xml, text/xml

Sample:Sample not available.

GET V1/CUSTOMERS/{CUSTOMERID}/QUOTES

REQUEST INFORMATION

URI PARAMETERS

Name Description Type Additional information
customerId integer Required

BODY PARAMETERS

None.

RESPONSE INFORMATION

RESOURCE DESCRIPTION

Collection of quoteDto

Name Description Type Additional information
quoteNumber string None.
id integer None.
objectType string None.

RESPONSE FORMATS

APPLICATION/JSON, TEXT/JSON

Sample:
[
  {
    "quoteNumber": "sample string 1",
    "id": 2,
    "objectType": "sample string 3"
  },
  {
    "quoteNumber": "sample string 1",
    "id": 2,
    "objectType": "sample string 3"
  }
]

APPLICATION/XML, TEXT/XML

Sample:
<ArrayOfquoteDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <quoteDto>
    <id>2</id>
    <objectType>sample string 3</objectType>
    <quoteNumber>sample string 1</quoteNumber>
  </quoteDto>
  <quoteDto>
    <id>2</id>
    <objectType>sample string 3</objectType>
    <quoteNumber>sample string 1</quoteNumber>
  </quoteDto>
</ArrayOfquoteDto>

GET v1/Agents/{id}

Retrieve agent details by agent Id

Request Information

URI PARAMETERS

Name Description Type Additional information
id agent id to lookup integer Required

BODY PARAMETERS

None.

 

RESPONSE INFORMATION

RESOURCE DESCRIPTION

agentDto

 

Name Description Type Additional information
FirstName string Max length: 30
LastName string Max length: 30
CommercialName string Max length: 500
Username string Required
Email string Required
Role Primary role of the agent AgentPrimaryRoleEnum None.
OrganizationIds Ids of the organizations the agent belongs to Collection of integer Required
ParentAgentId integer Required
ParentAgent AgentDTO None.
IsActive Indicates if the agent’s user account is currently activated boolean Required
Commissions Collection of AgentCommissionDTO None.
Licenses Collection of AgentLicenseDTO None.
ErrorsAndOmissions Collection of AgentErrorAndOmissionDTO None.
CommissionCalcType Calculation type for commission CommissionCalcTypeEnum None.
Agent1099Type 1099 type of the agency TenNinetyNineTypeEnum None.
W9Address W9 address of the agency SystemEntityAddressDTO None.
LocationAddress Location address of the agency SystemEntityAddressDTO None.
Id Primary Id integer None.

Response Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "CommercialName": "sample string 3",
  "Username": "sample string 4",
  "Password": "sample string 5",
  "Email": "sample string 6",
  "Role": "Unknown",
  "OrganizationIds": [
    1,
    2
  ],
  "ParentAgentId": 1,
  "IsActive": true,
  "Commissions": [
    {
      "EffectiveDate": "2019-04-09T13:22:15.195055-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.195055-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    },
    {
      "EffectiveDate": "2019-04-09T13:22:15.195055-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.195055-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    }
  ],
  "Licenses": [
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:22:15.1980503-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.1980503-10:00",
      "Id": 4
    },
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:22:15.1980503-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.1980503-10:00",
      "Id": 4
    }
  ],
  "ErrorsAndOmissions": [
    {
      "EffectiveDate": "2019-04-09T13:22:15.1980503-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.1980503-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    },
    {
      "EffectiveDate": "2019-04-09T13:22:15.1980503-10:00",
      "ExpirationDate": "2019-04-09T13:22:15.1980503-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    }
  ],
  "CommissionCalcType": "Unknown",
  "Agent1099Type": "Unknown",
  "W9Address": {
    "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
  },
  "LocationAddress": {
    "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
  },
  "Id": 7
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

POST v1/Agents

Create a new agent

Request Information

URI Parameters

None.

Body Parameters

Agent info

AgentDTO

Name Description Type Additional information
FirstName string Max length: 30
LastName string Max length: 30
CommercialName string Max length: 500
Username string Required.
Email string Required.
Role Primary role of the agent AgentPrimaryRoleEnum None.
OrganizationIds Ids of the organizations the agent belongs to Collection of integer Required
ParentAgentId integer Required.
ParentAgent AgentDTO None.
IsActive Indicates if the agent’s user account is currently activated boolean Required.
Commissions Collection of AgentCommissionDTO None.
Licenses Collection of AgentLicenseDTO None.
ErrorsAndOmissions Collection of AgentErrorAndOmissionDTO None.
CommissionCalcType Calculation type for commission CommissionCalcTypeEnum None.
Agent1099Type 1099 type of the agency TenNinetyNineTypeEnum None.
W9Address W9 address of the agency SystemEntityAddressDTO None.
LocationAddress Location address of the agency SystemEntityAddressDTO None.
Id Primary Id integer None.

Request Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "CommercialName": "sample string 3",
  "Username": "sample string 4",
  "Password": "sample string 5",
  "Email": "sample string 6",
  "Role": "Unknown",
  "OrganizationIds": [
    1,
    2
  ],
  "ParentAgentId": 1,
  "IsActive": true,
  "Commissions": [
    {
      "EffectiveDate": "2019-04-09T13:32:32.3826945-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3826945-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    },
    {
      "EffectiveDate": "2019-04-09T13:32:32.3826945-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3826945-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    }
  ],
  "Licenses": [
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:32:32.3856866-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3856866-10:00",
      "Id": 4
    },
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:32:32.3856866-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3856866-10:00",
      "Id": 4
    }
  ],
  "ErrorsAndOmissions": [
    {
      "EffectiveDate": "2019-04-09T13:32:32.3856866-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3856866-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    },
    {
      "EffectiveDate": "2019-04-09T13:32:32.3856866-10:00",
      "ExpirationDate": "2019-04-09T13:32:32.3856866-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    }
  ],
  "CommissionCalcType": "Unknown",
  "Agent1099Type": "Unknown",
  "W9Address": {
    "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
  },
  "LocationAddress": {
    "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
  },
  "Id": 7
}

application/xml

Sample:Sample not available.

text/xml

Sample:Sample not available.

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

Agent ID as int

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>

PUT v1/Agents/{id}

Update an existing agent by id

Request Information

URI Parameters

Name Description Type Additional information
id ID of agent to update integer Required

Body Parameters

New agent info

AgentDTO

Name Description Type Additional information
FirstName string Max length: 30
LastName string Max length: 30
CommercialName string Max length: 500
Username string Required.
Email string Required.
Role Primary role of the agent AgentPrimaryRoleEnum None.
OrganizationIds Ids of the organizations the agent belongs to Collection of integer Required
ParentAgentId integer Required.
ParentAgent AgentDTO None.
IsActive Indicates if the agent’s user account is currently activated boolean Required.
Commissions Collection of AgentCommissionDTO None.
Licenses Collection of AgentLicenseDTO None.
ErrorsAndOmissions Collection of AgentErrorAndOmissionDTO None.
CommissionCalcType Calculation type for commission CommissionCalcTypeEnum None.
Agent1099Type 1099 type of the agency TenNinetyNineTypeEnum None.
W9Address W9 address of the agency SystemEntityAddressDTO None.
LocationAddress Location address of the agency SystemEntityAddressDTO None.
Id Primary Id integer None.

Request Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "CommercialName": "sample string 3",
  "Username": "sample string 4",
  "Password": "sample string 5",
  "Email": "sample string 6",
  "Role": "Unknown",
  "OrganizationIds": [
    1,
    2
  ],
  "ParentAgentId": 1,
  "IsActive": true,
  "Commissions": [
    {
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    },
    {
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "StateId": 1,
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 2,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 4
    }
  ],
  "Licenses": [
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "Id": 4
    },
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "Id": 4
    }
  ],
  "ErrorsAndOmissions": [
    {
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    },
    {
      "EffectiveDate": "2019-04-09T13:48:10.3005186-10:00",
      "ExpirationDate": "2019-04-09T13:48:10.3005186-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    }
  ],
  "CommissionCalcType": "Unknown",
  "Agent1099Type": "Unknown",
  "W9Address": {
    "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
  },
  "LocationAddress": {
    "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
  },
  "Id": 7
}

application/xml

Sample:Sample not available.

text/xml

Sample:Sample not available.

application/x-www-form-urlencoded

Sample:Sample not available.


Response Information

Resource Description

200 Ok on success

IHttpActionResultNone.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:Sample not available.

 

PUT v1/Agents/Activate/{id}

Activate an agent by Id

Request Information

URI Parameters

Name Description Type Additional information
id ID of agent to update integer Required

Body Parameters

None.

Response Information

Resource Description

200 Ok on success

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:Sample not available.

PUT v1/Agents/Deactivate/{id}

Deactivate an agent by Id

Request Information

URI Parameters

Name Description Type Additional information
id Agent Id integer Required

BODY PARAMETERS

None.

Response Information

Resource Description

200 Ok on success

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:Sample not available

GET v1/Payment/History?PolicyNumber={PolicyNumber}&ItemNumber={ItemNumber}&AccountingDate={AccountingDate}&Description={Description}&PaymentType={PaymentType}&PaymentSource={PaymentSource}&EffectiveDate={EffectiveDate}&Amount={Amount}&ItemBalance={ItemBalance}&TransactionDetailId={TransactionDetailId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Retrieve payment history for a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber Policy number to retrieve associated payment history for string None.
ItemNumber Item Number string None.
AccountingDate Accounting Date string None.
Description Description string None.
PaymentType Payment Type string None.
PaymentSource Payment Source string None.
EffectiveDate Effective Date string None.
Amount Amount string None.
ItemBalance Item Balance string None.
TransactionDetailId Transaction Detail Id string None.
Limit Maximum number of records to return integer Range: inclusive between 1 and 2147483647
Offset Number of records to skip during search, useful for pagination integer Range: inclusive between 0 and 2147483647
Total Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. boolean None
SortDirection Direction of sort: Ascending or Descending SortDirection None
Sort Comma separated list of field names to sort by string None
Expand Comma separated list of expansions to include in results string None

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional information
Limit Echoed limit of request integer None.
Offset Echoed offset of request integer None.
Total Total records matching search, if requeste string None.
Data List of records matching the search Collection of PaymentHistoryDTO None.

Response Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "ItemNumber": 1,
      "AccountingDate": "2019-04-08T13:39:30.306043-10:00",
      "Description": "sample string 3",
      "Method": "sample string 4",
      "PaymentSource": "sample string 5",
      "EffectiveDate": "2019-04-08T13:39:30.306043-10:00",
      "Amount": 7.0,
      "Balance": 8.0
    },
    {
      "ItemNumber": 1,
      "AccountingDate": "2019-04-08T13:39:30.306043-10:00",
      "Description": "sample string 3",
      "Method": "sample string 4",
      "PaymentSource": "sample string 5",
      "EffectiveDate": "2019-04-08T13:39:30.306043-10:00",
      "Amount": 7.0,
      "Balance": 8.0
    }
  ]
}

application/xml, text/xml

Sample:
<PaymentHistoryListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Data>
    <PaymentHistoryDTO>
      <Id>9</Id>
      <AccountingDate>2019-04-08T13:39:30.306043-10:00</AccountingDate>
      <Amount>7</Amount>
      <Balance>8</Balance>
      <Description>sample string 3</Description>
      <EffectiveDate>2019-04-08T13:39:30.306043-10:00</EffectiveDate>
      <ItemNumber>1</ItemNumber>
      <Method>sample string 4</Method>
      <PaymentSource>sample string 5</PaymentSource>
    </PaymentHistoryDTO>
    <PaymentHistoryDTO>
      <Id>9</Id>
      <AccountingDate>2019-04-08T13:39:30.306043-10:00</AccountingDate>
      <Amount>7</Amount>
      <Balance>8</Balance>
      <Description>sample string 3</Description>
      <EffectiveDate>2019-04-08T13:39:30.306043-10:00</EffectiveDate>
      <ItemNumber>1</ItemNumber>
      <Method>sample string 4</Method>
      <PaymentSource>sample string 5</PaymentSource>
    </PaymentHistoryDTO>
  </Data>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <Total>1</Total>
</PaymentHistoryListResponse>

GET v1/Payment/Plan?LineOfBusiness={LineOfBusiness}&StateCode={StateCode}&UniversalAccountNumber={UniversalAccountNumber}&IsRenewal={IsRenewal}&EffectiveDate={EffectiveDate}

Request Information

URI Parameters

Name Description Type Additional information
LineOfBusiness string Required
Statecode string Required
UniversalAccountNumber string None.
IsRenewal boolean Default value is False
EffectiveDate date None

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentPlanDTO

Name Description Type Additional information
Description Bill plan string Required
Id Primary Id integer Required
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Description": "sample string 1",
    "Id": 2
  },
  {
    "Description": "sample string 1",
    "Id": 2
  }
]

application/xml, text/xml

Sample:
<ArrayOfPaymentPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <PaymentPlanDTO>
    <Id>2</Id>
    <Description>sample string 1</Description>
  </PaymentPlanDTO>
  <PaymentPlanDTO>
    <Id>2</Id>
    <Description>sample string 1</Description>
  </PaymentPlanDTO>
</ArrayOfPaymentPlanDTO>

GET v1/Payment/InstallmentSchedule?billPlanId={billPlanId}&premium={premium}&effectiveDate={effectiveDate}&termLength={termLength}

Request Information

URI Parameters

Name Description Type Additional information
billPlanId integer Required
premium decimal number Required
effectiveDate date None.
termLength QuoteTermEnum Default value is TwelveMonths

Body Parameters

None.

Response Information

Resource Description

Collection of InstallmentScheduleDTO

Name Description Type Additional information
Number integer None.
DueDate date None.
Amount decimal number None.
Fee decimal number None.s
Warningmessages List of warning messages encountered while servicing request Collection of string None.

 

Response Formats

application/json, text/json

Sample:
[
  {
    "Number": 1,
    "DueDate": "2019-04-08T15:49:09.167608-10:00",
    "Amount": 3.0,
    "Fee": 4.0
  },
  {
    "Number": 1,
    "DueDate": "2019-04-08T15:49:09.167608-10:00",
    "Amount": 3.0,
    "Fee": 4.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfInstallmentScheduleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <InstallmentScheduleDTO>
    <Id>5</Id>
    <Amount>3</Amount>
    <DueDate>2019-04-08T15:49:09.167608-10:00</DueDate>
    <Fee>4</Fee>
    <Number>1</Number>
  </InstallmentScheduleDTO>
  <InstallmentScheduleDTO>
    <Id>5</Id>
    <Amount>3</Amount>
    <DueDate>2019-04-08T15:49:09.167608-10:00</DueDate>
    <Fee>4</Fee>
    <Number>1</Number>
  </InstallmentScheduleDTO>
</ArrayOfInstallmentScheduleDTO>

GET v1/Payment/AutoPay?PolicyNumber={PolicyNumber}

Retrieve current auto pay information for a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional information
DayOfTheMonth Day of month on which deductions should be taken integer None.
Type Autopay account type AutopayTypeEnum None.
Last4Digits Last 4 digits of the payment method. string None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "DayOfTheMonth": 1,
  "Type": "Unknown",
  "Last4Digits": "sample string 1"
}

application/xml, text/xml

Sample:
<AutoPayOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>2</Id>
  <DayOfTheMonth>1</DayOfTheMonth>
  <Last4Digits>sample string 1</Last4Digits>
  <Type>Unknown</Type>
</AutoPayOutboundDTO

GET v1/Payment/BillHistory?PolicyNumber={PolicyNumber}

Retrieve bill history for a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional information
AccountingDate date None.
BillPrepDate date None.
DueDate date None.
PolicyBillType BillTypeEnum None.
BillingCycle BillingCycleEnum None.
BillPlanDescription string None.
AutoPayType AutopayTypeEnum None.
AmountDue decimal number None.
MinimumAmountDue decimal number  None.
Id integer None.
WarningMessages List of warning messages encountered while servicing request None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AccountingDate": "2019-04-09T08:51:23.7648258-10:00",
    "BillPrepDate": "2019-04-09T08:51:23.7648258-10:00",
    "DueDate": "2019-04-09T08:51:23.7648258-10:00",
    "PolicyBillType": "Unknown",
    "BillingCycle": "Unknown",
    "BillPlanDescription": "sample string 1",
    "AutoPayType": "Unknown",
    "AmountDue": 2.0,
    "MinimumAmountDue": 3.0,
    "Id": 4
  },
  {
    "AccountingDate": "2019-04-09T08:51:23.7648258-10:00",
    "BillPrepDate": "2019-04-09T08:51:23.7648258-10:00",
    "DueDate": "2019-04-09T08:51:23.7648258-10:00",
    "PolicyBillType": "Unknown",
    "BillingCycle": "Unknown",
    "BillPlanDescription": "sample string 1",
    "AutoPayType": "Unknown",
    "AmountDue": 2.0,
    "MinimumAmountDue": 3.0,
    "Id": 4
  }
]

application/xml, text/xml

Sample:
<ArrayOfBillHistoryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <BillHistoryDTO>
    <Id>0</Id>
    <AccountingDate>2019-04-09T08:51:23.7648258-10:00</AccountingDate>
    <AmountDue>2</AmountDue>
    <AutoPayType>Unknown</AutoPayType>
    <BillPlanDescription>sample string 1</BillPlanDescription>
    <BillPrepDate>2019-04-09T08:51:23.7648258-10:00</BillPrepDate>
    <BillingCycle>Unknown</BillingCycle>
    <DueDate>2019-04-09T08:51:23.7648258-10:00</DueDate>
    <Id>4</Id>
    <MinimumAmountDue>3</MinimumAmountDue>
    <PolicyBillType>Unknown</PolicyBillType>
  </BillHistoryDTO>
  <BillHistoryDTO>
    <Id>0</Id>
    <AccountingDate>2019-04-09T08:51:23.7648258-10:00</AccountingDate>
    <AmountDue>2</AmountDue>
    <AutoPayType>Unknown</AutoPayType>
    <BillPlanDescription>sample string 1</BillPlanDescription>
    <BillPrepDate>2019-04-09T08:51:23.7648258-10:00</BillPrepDate>
    <BillingCycle>Unknown</BillingCycle>
    <DueDate>2019-04-09T08:51:23.7648258-10:00</DueDate>
    <Id>4</Id>
    <MinimumAmountDue>3</MinimumAmountDue>
    <PolicyBillType>Unknown</PolicyBillType>
  </BillHistoryDTO>
</ArrayOfBillHistoryDTO>

PUT v1/Payment/DisableAutoPay?PolicyNumber={PolicyNumber}

Disable auto payment for a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

PUT v1/Payment/UpdateAutoPayCC?PolicyNumber={PolicyNumber}

Update credit card auto payment details for a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required

Body Parameters

AutoPayCCDTO

Name Description Type Additional information
CreditCardId Id of credit card previously added to system integer None.
CreditCardNumber string None.
CreditCardType CreditCardTypeEnum None.
CardSecurityCode string Max length: -1
MonthOfExpirationDate integer Range: inclusive between 1 and 1
YearOfExpirationDate integer None.
CardHolderName string None.
CardHolderAddress AddressDTO None.
AuthorizationType AutopayAuthorizationTypeEnum Required.
AutoPayDayOfMonth integer Required.
Id integer None.
Expand string None.

Request Formats

application/json, text/json

Sample:
{
  "CreditCardId": 1,
  "CreditCardNumber": "samplestring1",
  "CreditCardType": "Unknown",
  "CardSecurityCode": "sample string 2",
  "MonthOfExpirationDate": 1,
  "YearOfExpirationDate": 1,
  "CardHolderName": "sample string 3",
  "CardHolderAddress": {
    "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
  },
  "AuthorizationType": "Unknown",
  "AutoPayDayOfMonth": 4,
  "Id": 5,
  "Expand": ""
}

application/xml, text/xml

Sample:
<AutoPayCCDTO 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>5</Id>
  <AuthorizationType>Unknown</AuthorizationType>
  <AutoPayDayOfMonth>4</AutoPayDayOfMonth>
  <CardHolderAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
    <d2p1:Expand></d2p1:Expand>
    <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <d2p1:Id>9</d2p1:Id>
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:County>sample string 5</d2p1:County>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zipcode1>sample string 7</d2p1:Zipcode1>
    <d2p1:Zipcode2>sample string 8</d2p1:Zipcode2>
  </CardHolderAddress>
  <CardHolderName>sample string 3</CardHolderName>
  <CardSecurityCode>sample string 2</CardSecurityCode>
  <CreditCardId>1</CreditCardId>
  <CreditCardNumber>samplestring1</CreditCardNumber>
  <CreditCardType>Unknown</CreditCardType>
  <MonthOfExpirationDate>1</MonthOfExpirationDate>
  <YearOfExpirationDate>1</YearOfExpirationDate>
</AutoPayCCDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

Name Description Type Additional information
DayOfTheMonth Day of month on which deductions should be taken integer None.
Type Autopay account type AutopayTypeEnum None.
Last4Digits Last 4 digits of the payment method. string None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "DayOfTheMonth": 1,
  "Type": "Unknown",
  "Last4Digits": "sample string 1"
}

application/xml, text/xml

Sample:
<AutoPayOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>2</Id>
  <DayOfTheMonth>1</DayOfTheMonth>
  <Last4Digits>sample string 1</Last4Digits>
  <Type>Unknown</Type>
</AutoPayOutboundDTO>

PUT v1/Payment/UpdateAutoPayEFT?PolicyNumber={PolicyNumber}

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required

Body Parameters

AutoPayEFTDTO

Name Description Type Additional information
EFTId integer None.
BankTransitNumber string None.
AccountHolderName string None.
AccountNumber string None.
EFTBankAccountType BankAccountTypeEnum None.
AuthorizationType AutopayAuthorizationTypeEnum Required.
AutoPayDayOfMonth integer Required.
Id integer None.
Expand string None.

Request Formats

application/json, text/json

Sample:
{
  "EFTId": 1,
  "BankTransitNumber": "sample string 2",
  "AccountHolderName": "sample string 3",
  "AccountNumber": "sample string 4",
  "EFTBankAccountType": 0,
  "AuthorizationType": "Unknown",
  "AutoPayDayOfMonth": 5,
  "Id": 6,
  "Expand": ""
}

application/xml, text/xml

Sample:
<AutoPayEFTDTO 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>6</Id>
  <AuthorizationType>Unknown</AuthorizationType>
  <AutoPayDayOfMonth>5</AutoPayDayOfMonth>
  <AccountHolderName>sample string 3</AccountHolderName>
  <AccountNumber>sample string 4</AccountNumber>
  <BankTransitNumber>sample string 2</BankTransitNumber>
  <EFTBankAccountType>Unknown</EFTBankAccountType>
  <EFTId>1</EFTId>
</AutoPayEFTDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

AutoPayOutboundDTO

Name Description Type Additional information
DayOfTheMonth Day of month on which deductions should be taken integer None.
Type Autopay account type AutopayTypeEnum None.
Last4Digits Last 4 digits of the payment method. string None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "DayOfTheMonth": 1,
  "Type": "Unknown",
  "Last4Digits": "sample string 1"
}

application/xml, text/xml

Sample:
<AutoPayOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>2</Id>
  <DayOfTheMonth>1</DayOfTheMonth>
  <Last4Digits>sample string 1</Last4Digits>
  <Type>Unknown</Type>
</AutoPayOutboundDTO>

POST v1/Payment/PostPayment

Post Payment

Request Information

URI Parameters

None.

Body Parameters

PaymentDTO

Name Description Type Additional information
SuspenseType SuspenseTypeEnum None.
UserId integer None.
PolicyNumber string None.
APNNumber string None.
BillingPaymentType BillingPaymentTypeEnum None.
PayorType PayorTypeEnum Required.
PostmarkDate date Required.
TransactionAmount decimal number None.
NetPayment decimal number None.
PaymentSource string None.
EPayTransactionId integer None.
SpeedpayTransactionId integer None.
QuoteNumber string None.
FirstName string None.
MiddleName string None.
LastName string None.
CommercialName string None.
PhoneNumber string None.
Address EntityAddressDTO None.

Request Formats

application/json, text/json

 

Sample:
{
  "SuspenseType": "Unknown",
  "UserId": 1,
  "PolicyNumber": "sample string 2",
  "APNNumber": "sample string 3",
  "BillingPaymentType": "Unknown",
  "PayorType": "Unknown",
  "PostmarkDate": "2019-04-09T10:56:37.6366765-10:00",
  "TransactionAmount": 1.0,
  "NetPayment": 1.0,
  "PaymentSource": "sample string 4",
  "EPayTransactionId": 1,
  "SpeedpayTransactionId": 1,
  "QuoteNumber": "sample string 5",
  "FirstName": "sample string 6",
  "MiddleName": "sample string 7",
  "LastName": "sample string 8",
  "CommercialName": "sample string 9",
  "PhoneNumber": "sample string 10",
  "Address": {
    "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
  }
}

application/xml, text/xml

Sample:
PaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <APNNumber>sample string 3</APNNumber>
  <Address>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>9</Id>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <County>sample string 5</County>
    <State>sample string 4</State>
    <Zipcode1>sample string 7</Zipcode1>
    <Zipcode2>sample string 8</Zipcode2>
    <Type>Unknown</Type>
  </Address>
  <BillingPaymentType>Unknown</BillingPaymentType>
  <CommercialName>sample string 9</CommercialName>
  <EPayTransactionId>1</EPayTransactionId>
  <FirstName>sample string 6</FirstName>
  <LastName>sample string 8</LastName>
  <MiddleName>sample string 7</MiddleName>
  <NetPayment>1</NetPayment>
  <PaymentSource>sample string 4</PaymentSource>
  <PayorType>Unknown</PayorType>
  <PhoneNumber>sample string 10</PhoneNumber>
  <PolicyNumber>sample string 2</PolicyNumber>
  <PostmarkDate>2019-04-09T10:56:37.6366765-10:00</PostmarkDate>
  <QuoteNumber>sample string 5</QuoteNumber>
  <SpeedpayTransactionId>1</SpeedpayTransactionId>
  <SuspenseType>Unknown</SuspenseType>
  <TransactionAmount>1</TransactionAmount>
  <UserId>1</UserId>
</PaymentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Payment Response class

PaymentAPIResponse

Name Description Type Additional information
Status PaymentStatusEnum None.
ErrorType PaymentAPIErrorTypeEnum None.
ResponseValue string None.
IsRenewal Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "ErrorType": 0,
  "ResponseValue": "sample string 1",
  "ErrorMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessages>
  <ErrorType>Unknown</ErrorType>
  <ResponseValue>sample string 1</ResponseValue>
  <Status>Processing</Status>
</PaymentAPIResponse>

POST v1/Payment/AssignPolicyNumber?quoteNumber={quoteNumber}

Assign and return policy number for early cash quote

Request Information

URI Parameters

Name Description Type Additional information
quoteNumber string Required

Body Parameters

None.

Response Information

Resource Description

Payment Response class

PaymentAPIResponse

Name Description Type Additional information
Status PaymentStatusEnum None.
ErrorType PaymentAPIErrorTypeEnum None.
ResponseValue string None.
ErrorMessages Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "ErrorType": 0,
  "ResponseValue": "sample string 1",
  "ErrorMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessages>
  <ErrorType>Unknown</ErrorType>
  <ResponseValue>sample string 1</ResponseValue>
  <Status>Processing</Status>
</PaymentAPIResponse>

GET v1/Payment/FindPolicyNumberByAPN?apnNo={apnNo}

Retrieve policy number that matches the given APN number

Request Information

URI Parameters

Name Description Type Additional information
apnNo string Required

Body Parameters

None.

Response Information

Resource Description

Payment Response class

PaymentAPIResponse

Name Description Type Additional information
Status PaymentStatusEnum None.
ErrorType PaymentAPIErrorTypeEnum None.
ResponseValue string None.
ErrorMessages Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "ErrorType": 0,
  "ResponseValue": "sample string 1",
  "ErrorMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessages>
  <ErrorType>Unknown</ErrorType>
  <ResponseValue>sample string 1</ResponseValue>
  <Status>Processing</Status>
</PaymentAPIResponse>

GET v1/Payment/FindQuoteNumberByAPN?apnNo={apnNo}

Retrieve quote number that matches the given APN number

Request Information

URI Parameters

Name Description Type Additional information
apnNo string Required

Body Parameters

None.

Response Information

Resource Description

Payment Response class

PaymentAPIResponse

Name Description Type Additional information
Status PaymentStatusEnum None.
ErrorType PaymentAPIErrorTypeEnum None.
ResponseValue string None.
ErrorMessages Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "ErrorType": 0,
  "ResponseValue": "sample string 1",
  "ErrorMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessages>
  <ErrorType>Unknown</ErrorType>
  <ResponseValue>sample string 1</ResponseValue>
  <Status>Processing</Status>
</PaymentAPIResponse>

GET v1/Policy?Id={Id}&EffectiveDate={EffectiveDate}&ExpirationDate={ExpirationDate}&PolicyNumber={PolicyNumber}&LineOfBusiness={LineOfBusiness}&State={State}&UnderwritingCompanyId={UnderwritingCompanyId}&UniversalAccountId={UniversalAccountId}&CustomerId={CustomerId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Retrieves policies satistfying the filter criteria.

Request Information

URI Parameters

Name Description Type Additional information
Id string None.
EffectiveDate string None.
ExpirationDate string None.
PolicyNumber string None.
LineOfBusiness string None.
State string None.
UnderwritingCompanyId string None.
UniversalAccountId string None.
CustomerId string None.
Limit Maximum number of records to return integer Range: inclusive between 1 and 2147483647
Offset Number of records to skip during search, useful for pagination integer Range: inclusive between 0 and 2147483647
Total Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. boolean None.
SortDirection Direction of sort: Ascending or Descending SortDirection None.
Sort Comma separated list of field names to sort by string None.
Expand Comma separated list of expansions to include in results string None.

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional information
Limit Echoed limit of request integer None.
Offset Echoed offset of request integer None.
Total Total records matching search, if requested integer None.
Data List of records matching the search Collection of PolicyOutboundDTO None.

Response Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "AgencyId": 1,
      "AgentId": 1,
      "SubagencyId": 1,
      "CustomerId": 1,
      "Customer": {
        "FirstName": "sample string 1",
        "Id": 2,
        "LastName": "sample string 3",
        "CommercialName": "sample string 4",
        "Type": "Unknown",
        "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
        },
        "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
        },
        "MobilePhone": "sample string 5",
        "HomePhone": "sample string 6",
        "Quotes": [
          {
            "AgencyId": 1,
            "AgentId": 1,
            "SubagencyId": 1,
            "BillPlanId": 1,
            "RenewalBillPlanId": 1,
            "CustomerId": 1,
            "CompleteQuote": true,
            "EffectiveDate": "2019-04-09T14:16:28.8571923-10:00",
            "ExpirationDate": "2019-04-09T14:16:28.8571923-10:00",
            "QuoteTerm": "Unknown",
            "LineOfBusiness": "sample string 3",
            "PolicyNumber": "sample string 4",
            "Premium": 1.0,
            "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
              },
              "Type": "Unknown",
              "Id": 7
            },
            "QuoteNumber": "sample string 5",
            "RateGuaranteeDate": "2019-04-09T14:16:28.8581903-10:00",
            "RatingTaxa": "sample string 6",
            "State": "sample string 7",
            "Country": "sample string 8",
            "UnderwritingCompanyId": 9,
            "UniversalAccountId": 10,
            "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
            },
            "Id": 11
          },
          {
            "AgencyId": 1,
            "AgentId": 1,
            "SubagencyId": 1,
            "BillPlanId": 1,
            "RenewalBillPlanId": 1,
            "CustomerId": 1,
            "CompleteQuote": true,
            "EffectiveDate": "2019-04-09T14:16:28.8571923-10:00",
            "ExpirationDate": "2019-04-09T14:16:28.8571923-10:00",
            "QuoteTerm": "Unknown",
            "LineOfBusiness": "sample string 3",
            "PolicyNumber": "sample string 4",
            "Premium": 1.0,
            "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
              },
              "Type": "Unknown",
              "Id": 7
            },
            "QuoteNumber": "sample string 5",
            "RateGuaranteeDate": "2019-04-09T14:16:28.8581903-10:00",
            "RatingTaxa": "sample string 6",
            "State": "sample string 7",
            "Country": "sample string 8",
            "UnderwritingCompanyId": 9,
            "UniversalAccountId": 10,
            "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
            },
            "Id": 11
          }
        ]
      },
      "EffectiveDate": "2019-04-09T14:16:28.8591886-10:00",
      "ExpirationDate": "2019-04-09T14:16:28.8591886-10:00",
      "LineOfBusiness": "sample string 1",
      "PolicyNumber": "sample string 2",
      "UnderlyingPolicyNumber": "sample string 3",
      "Premium": 4.0,
      "BillPlanId": 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
        },
        "Type": "Unknown",
        "Id": 7
      },
      "RateGuaranteeDate": "2019-04-09T14:16:28.8601844-10:00",
      "RatingTaxa": "sample string 5",
      "State": "sample string 6",
      "Country": "sample string 7",
      "UnderwritingCompanyId": 8,
      "UniversalAccountId": 9,
      "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
      },
      "Id": 10
    },
    {
      "AgencyId": 1,
      "AgentId": 1,
      "SubagencyId": 1,
      "CustomerId": 1,
      "Customer": {
        "FirstName": "sample string 1",
        "Id": 2,
        "LastName": "sample string 3",
        "CommercialName": "sample string 4",
        "Type": "Unknown",
        "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
        },
        "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
        },
        "MobilePhone": "sample string 5",
        "HomePhone": "sample string 6",
        "Quotes": [
          {
            "AgencyId": 1,
            "AgentId": 1,
            "SubagencyId": 1,
            "BillPlanId": 1,
            "RenewalBillPlanId": 1,
            "CustomerId": 1,
            "CompleteQuote": true,
            "EffectiveDate": "2019-04-09T14:16:28.8571923-10:00",
            "ExpirationDate": "2019-04-09T14:16:28.8571923-10:00",
            "QuoteTerm": "Unknown",
            "LineOfBusiness": "sample string 3",
            "PolicyNumber": "sample string 4",
            "Premium": 1.0,
            "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
              },
              "Type": "Unknown",
              "Id": 7
            },
            "QuoteNumber": "sample string 5",
            "RateGuaranteeDate": "2019-04-09T14:16:28.8581903-10:00",
            "RatingTaxa": "sample string 6",
            "State": "sample string 7",
            "Country": "sample string 8",
            "UnderwritingCompanyId": 9,
            "UniversalAccountId": 10,
            "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
            },
            "Id": 11
          },
          {
            "AgencyId": 1,
            "AgentId": 1,
            "SubagencyId": 1,
            "BillPlanId": 1,
            "RenewalBillPlanId": 1,
            "CustomerId": 1,
            "CompleteQuote": true,
            "EffectiveDate": "2019-04-09T14:16:28.8571923-10:00",
            "ExpirationDate": "2019-04-09T14:16:28.8571923-10:00",
            "QuoteTerm": "Unknown",
            "LineOfBusiness": "sample string 3",
            "PolicyNumber": "sample string 4",
            "Premium": 1.0,
            "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
              },
              "Type": "Unknown",
              "Id": 7
            },
            "QuoteNumber": "sample string 5",
            "RateGuaranteeDate": "2019-04-09T14:16:28.8581903-10:00",
            "RatingTaxa": "sample string 6",
            "State": "sample string 7",
            "Country": "sample string 8",
            "UnderwritingCompanyId": 9,
            "UniversalAccountId": 10,
            "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
            },
            "Id": 11
          }
        ]
      },
      "EffectiveDate": "2019-04-09T14:16:28.8591886-10:00",
      "ExpirationDate": "2019-04-09T14:16:28.8591886-10:00",
      "LineOfBusiness": "sample string 1",
      "PolicyNumber": "sample string 2",
      "UnderlyingPolicyNumber": "sample string 3",
      "Premium": 4.0,
      "BillPlanId": 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
        },
        "Type": "Unknown",
        "Id": 7
      },
      "RateGuaranteeDate": "2019-04-09T14:16:28.8601844-10:00",
      "RatingTaxa": "sample string 5",
      "State": "sample string 6",
      "Country": "sample string 7",
      "UnderwritingCompanyId": 8,
      "UniversalAccountId": 9,
      "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
      },
      "Id": 10
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

GET v1/Policy/{PolicyNumber}

Retrieves the details of a policy by policy number

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber the policy number to lookup string Required

Body Parameters

None.

Response Information

Resource Description

PolicyProductDTO

PolicyProductInboundDTO

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

Response Formats

application/json, text/json

Sample:
{
  "Policy": {
    "EffectiveDate": "2019-04-09T14:36:45.1128751-10:00",
    "ExpirationDate": "2019-04-09T14:36:45.1128751-10:00",
    "PolicyNumber": "sample string 1",
    "UnderlyingPolicyNumber": "sample string 2",
    "BillPlanId": 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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2019-04-09T14:36:45.1158671-10:00",
    "RatingTaxa": "sample string 3",
    "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
    },
    "Id": 4,
    "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>4</Id>
    <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>
    <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>
    <BillPlanId>1</BillPlanId>
    <EffectiveDate>2019-04-09T14:36:45.1128751-10:00</EffectiveDate>
    <ExpirationDate>2019-04-09T14:36:45.1128751-10:00</ExpirationDate>
    <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: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>
    <RateGuaranteeDate>2019-04-09T14:36:45.1158671-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 3</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <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>
    <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber>
  </Policy>
  <Product />
</PolicyProductInboundDTO>

GET v1/Policy/{PolicyNumber}/Status

Retrieves the status of a policy by policy number

Request Information

Name Description Type Additional information
PolicyNumber the policy number to lookup string Required

Body Parameters

None.

Response Information

Resource Description

StatusDTO

StatusDTO

Name Description Type Additional informationStatus
Status string None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1"
}

application/xml, text/xml

Sample:
<StatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>2</Id>
  <Status>sample string 1</Status>
</StatusDTO>

POST v1/Policy/Cancel?PolicyNumber={PolicyNumber}&AmendEffDate={AmendEffDate}&Note={Note}&CancelTypeId={CancelTypeId}

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required
AmendEffDate date Required
Note string Required
CancelTypeId integer Default value is 103

Body Parameters

None.

Response Information

Resource Description

IHttpActionResultNone.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

POST v1/Policy/DoNotReinstate?PolicyNumber={PolicyNumber}

Add Do Not Reinstate flag to a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber the policy number to lookup string Required

Body Parameters

None.

Response Information

Resource Description

IHttpActionResultNone.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

POST v1/Policy/ReverseDoNotReinstate?PolicyNumber={PolicyNumber}

Remove Do Not Reinstate flag from a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber the policy number to lookup string Required

Body Parameters

None.

Response Information

Resource Description

IHttpActionResultNone.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

POST v1/Policy/Rewrite?PolicyNumber={PolicyNumber}

Rewrite a policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber the policy number to lookup string Required

Body Parameters

None.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
PolicyId integer None.
ProductId integer None.
PolicyNumber string None.
WarningMessages List of warning messages encountered while servicing requests Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyId": 1,
  "ProductId": 1,
  "PolicyNumber": "sample string 2"
}

application/xml, text/xml

Sample:

POST v1/Policy

Create a new policy

Request Information

URI Parameters

None.

Body Parameters

the policy and product data

CreatePolicyProductInboundDTO

Name Description Type Additional information
Policy CreatePolicyInboundDTO Required.
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": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "CustomerId": 1,
    "LineOfBusiness": "sample string 2",
    "State": "sample string 3",
    "Country": "sample string 4",
    "UnderwritingCompanyId": 5,
    "UniversalAccountId": 6,
    "EffectiveDate": "2019-04-09T15:21:18.8503813-10:00",
    "ExpirationDate": "2019-04-09T15:21:18.8503813-10:00",
    "PolicyNumber": "sample string 7",
    "UnderlyingPolicyNumber": "sample string 8",
    "BillPlanId": 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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2019-04-09T15:21:18.8503813-10:00",
    "RatingTaxa": "sample string 9",
    "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
    },
    "Id": 10,
    "Expand": ""
  },
  "Product": {},
  "Id": 2,
  "Expand": ""
}

application/xml, text/xml

Sample:
CreatePolicyProductInboundDTO 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>4</Id>
    <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>
    <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>
    <BillPlanId>1</BillPlanId>
    <EffectiveDate>2019-04-09T15:21:18.8503813-10:00</EffectiveDate>
    <ExpirationDate>2019-04-09T15:21:18.8503813-10:00</ExpirationDate>
    <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: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>
    <RateGuaranteeDate>2019-04-09T15:21:18.8503813-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 3</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <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>
    <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber>
  </Policy>
  <Product />
  <Policy>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>10</Id>
    <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>
    <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>
    <BillPlanId>1</BillPlanId>
    <EffectiveDate>2019-04-09T15:21:18.8503813-10:00</EffectiveDate>
    <ExpirationDate>2019-04-09T15:21:18.8503813-10:00</ExpirationDate>
    <PolicyNumber>sample string 7</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: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>
    <RateGuaranteeDate>2019-04-09T15:21:18.8503813-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 9</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <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>
    <UnderlyingPolicyNumber>sample string 8</UnderlyingPolicyNumber>
    <AgencyId>1</AgencyId>
    <AgentId>1</AgentId>
    <Country>sample string 4</Country>
    <CustomerId>1</CustomerId>
    <LineOfBusiness>sample string 2</LineOfBusiness>
    <State>sample string 3</State>
    <SubagencyId>1</SubagencyId>
    <UnderwritingCompanyId>5</UnderwritingCompanyId>
    <UniversalAccountId>6</UniversalAccountId>
  </Policy>
</CreatePolicyProductInboundDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
PolicyId integer None.
ProductId integer None.
PolicyNumber string None.
WarningMessages List of warning messages encountered while servicing requests Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyId": 1,
  "ProductId": 1,
  "PolicyNumber": "sample string 2"
}

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>3</Id>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 2</PolicyNumber>
  <ProductId>1</ProductId>
</SimplePolicyResponseDTO>

PUT v1/Policy/amend?PolicyNumber={PolicyNumber}&amendEffDate={amendEffDate}&note={note}

Update an existing policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required
amendEffDate date Required
note string Required

Body Parameters

the policy and product data

PolicyProductInboundDTO

 

Name Description Type Additional information
PolicyId integer None.
ProductId integer None.
PolicyNumber string None.
WarningMessages List of warning messages encountered while servicing requests Collection of string None.

Request Formats

application/json, text/json

Sample:
{
  "Policy": {
    "EffectiveDate": "2019-04-09T15:27:54.8134794-10:00",
    "ExpirationDate": "2019-04-09T15:27:54.8134794-10:00",
    "PolicyNumber": "sample string 1",
    "UnderlyingPolicyNumber": "sample string 2",
    "BillPlanId": 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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2019-04-09T15:27:54.8154741-10:00",
    "RatingTaxa": "sample string 3",
    "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
    },
    "Id": 4,
    "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>4</Id>
    <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>
    <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>
    <BillPlanId>1</BillPlanId>
    <EffectiveDate>2019-04-09T15:27:54.8134794-10:00</EffectiveDate>
    <ExpirationDate>2019-04-09T15:27:54.8134794-10:00</ExpirationDate>
    <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: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>
    <RateGuaranteeDate>2019-04-09T15:27:54.8154741-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 3</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <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>
    <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber>
  </Policy>
  <Product />
</PolicyProductInboundDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
PolicyId integer None.
ProductId integer None.
PolicyNumber string None.
WarningMessages List of warning messages encountered while servicing requests Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyId": 1,
  "ProductId": 1,
  "PolicyNumber": "sample string 2"
}

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>3</Id>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 2</PolicyNumber>
  <ProductId>1</ProductId>
</SimplePolicyResponseDTO>

PATCH v1/Policy/amend?PolicyNumber={PolicyNumber}&amendEffDate={amendEffDate}&note={note}

Partially update an existing policy

Request Information

URI Parameters

Name Description Type Additional information
PolicyNumber string Required
amendEffDate date Required
note string Required

Body Parameters

JsonPatchDocument

Name Description Type Additional information
Operations Collection of Operation None.

Request Formats

application/json, text/json

Sample:
[
  {
    "path": "sample string 2",
    "op": "sample string 3"
  },
  {
    "path": "sample string 2",
    "op": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<JsonPatchDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNetCore.JsonPatch">
  <ContractResolver i:nil="true" />
</JsonPatchDocument>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
PolicyId integer None.
ProductId integer None.
PolicyNumber string None.
WarningMessages List of warning messages encountered while servicing requests Collection of string None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyId": 1,
  "ProductId": 1,
  "PolicyNumber": "sample string 2"
}

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>3</Id>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 2</PolicyNumber>
  <ProductId>1</ProductId>
</SimplePolicyResponseDTO>

GET v1/Quotes/{QuoteNumber}

Retrieves the details of a quote by quote number

Request Information

URI Parameters

Name Description Type Additional information
QuoteNumber the quote number to lookup

s

string Required

Body Parameters

None.

Response Information

Resource Description

QuoteProductDTO

QuoteProductOutboundDTO

Name Description Type Additional information
Quote QuoteOutboundDTO Required
Product Object Required
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample
{
  "Quote": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "BillPlanId": 1,
    "RenewalBillPlanId": 1,
    "CustomerId": 1,
    "CompleteQuote": true,
    "Customer": {
      "FirstName": "sample string 1",
      "Id": 2,
      "LastName": "sample string 3",
      "CommercialName": "sample string 4",
      "Type": "Unknown",
      "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
      },
      "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
      },
      "MobilePhone": "sample string 5",
      "HomePhone": "sample string 6",
      "Quotes": []
    },
    "EffectiveDate": "2019-04-10T09:02:11.5714125-10:00",
    "ExpirationDate": "2019-04-10T09:02:11.5714125-10:00",
    "QuoteTerm": "Unknown",
    "LineOfBusiness": "sample string 3",
    "PolicyNumber": "sample string 4",
    "Premium": 1.0,
    "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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "QuoteNumber": "sample string 5",
    "RateGuaranteeDate": "2019-04-10T09:02:11.5723905-10:00",
    "RatingTaxa": "sample string 6",
    "State": "sample string 7",
    "Country": "sample string 8",
    "UnderwritingCompanyId": 9,
    "UniversalAccountId": 10,
    "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
    },
    "Id": 11
  },
  "Product": {}
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

GET v1/Quotes/{QuoteNumber}/Status

Retrieves the status of a quote by quote number

Request Information

URI Parameters

Name Description Type Additional information
QuoteNumber the quote number to lookup

s

string Required

Body Parameters

None.

Response Information

Resource Description

StatusDTO

Name Description Type Additional information
Status String None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1"
}

application/xml, text/xml

Sample:

<StatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>2</Id>
  <Status>sample string 1</Status>
</StatusDTO>

POST v1/Quotes

Create a new quote

Request Information

URI Parameters

None.

Body Parameters

the quote and product data

QuoteProductInboundDTO

Name Description Type Additional information
Quote QuoteOutboundDTO Required
Product Object Required
Expand Comma separated list of expansions to include in results string None.

Request Formats

application/json, text/json

Sample:

{
  "Quote": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "BillPlanId": 1,
    "RenewalBillPlanId": 1,
    "CustomerId": 1,
    "EffectiveDate": "2019-04-10T09:14:14.8656112-10:00",
    "QuoteTerm": "Unknown",
    "LineOfBusiness": "sample string 2",
    "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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2019-04-10T09:14:14.8656112-10:00",
    "RatingTaxa": "sample string 3",
    "State": "sample string 4",
    "Country": "sample string 5",
    "UnderwritingCompanyId": 6,
    "UniversalAccountId": 7,
    "QuoteNumber": "sample string 8",
    "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
    },
    "Id": 9,
    "Expand": ""
  },
  "Product": {},
  "Expand": ""
}

application/xml, text/xml

Sample:

<QuoteProductInboundDTO 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>
  <Product />
  <Quote>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>9</Id>
    <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>
    <Country>sample string 5</Country>
    <CustomerId>1</CustomerId>
    <EffectiveDate>2019-04-10T09:14:14.8656112-10:00</EffectiveDate>
    <LineOfBusiness>sample string 2</LineOfBusiness>
    <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: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>
    <QuoteNumber>sample string 8</QuoteNumber>
    <QuoteTerm>Unknown</QuoteTerm>
    <RateGuaranteeDate>2019-04-10T09:14:14.8656112-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 3</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <State>sample string 4</State>
    <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>
    <UnderwritingCompanyId>6</UnderwritingCompanyId>
    <UniversalAccountId>7</UniversalAccountId>
  </Quote>
</QuoteProductInboundDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimpleQuoteResponseDTO

Name Description Type Additional information
QuoteId integer None.
QuoteNumber string None.
ProductId integer None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:

{
  "QuoteId": 1,
  "QuoteNumber": "sample string 2",
  "ProductId": 1
}

application/xml, text/xml

Sample:

<SimpleQuoteResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>3</Id>
  <ProductId>1</ProductId>
  <QuoteId>1</QuoteId>
  <QuoteNumber>sample string 2</QuoteNumber>
</SimpleQuoteResponseDTO>

PATCH v1/Quotes?QuoteNumber={QuoteNumber}

Partially update an existing quote

Request Information

URI Parameters

Name Description Type Additional information
QuoteNumber the quote number to lookup

s

string Required

Body Parameters

JsonPatchDocument

Name Description Type Additional information
Operations Collection of Operation None

Request Formats

application/json, text/json

Sample:

[
  {
    "path": "sample string 2",
    "op": "sample string 3"
  },
  {
    "path": "sample string 2",
    "op": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<JsonPatchDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNetCore.JsonPatch">
  <ContractResolver i:nil="true" />
</JsonPatchDocument>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
QuoteId integer None.
QuoteNumber string None.
ProductId integer None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:

{
  "QuoteId": 1,
  "QuoteNumber": "sample string 2",
  "ProductId": 1
}

application/xml, text/xml

Sample:

<SimpleQuoteResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>3</Id>
  <ProductId>1</ProductId>
  <QuoteId>1</QuoteId>
  <QuoteNumber>sample string 2</QuoteNumber>
</SimpleQuoteResponseDTO>

PUT v1/Quotes

Update an existing quote

Request Information

URI Parameters

None.

Body Parameters

the quote and product data

QuoteProductInboundDTO

Name Description Type Additional information
Quote QuoteOutboundDTO Required
Product Object Required
Expand Comma separated list of expansions to include in results string None.

Request Formats

application/json, text/json

Sample:

{
  "Quote": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "BillPlanId": 1,
    "RenewalBillPlanId": 1,
    "CustomerId": 1,
    "EffectiveDate": "2019-04-10T09:27:16.5162457-10:00",
    "QuoteTerm": "Unknown",
    "LineOfBusiness": "sample string 2",
    "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
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2019-04-10T09:27:16.5162457-10:00",
    "RatingTaxa": "sample string 3",
    "State": "sample string 4",
    "Country": "sample string 5",
    "UnderwritingCompanyId": 6,
    "UniversalAccountId": 7,
    "QuoteNumber": "sample string 8",
    "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
    },
    "Id": 9,
    "Expand": ""
  },
  "Product": {},
  "Expand": ""
}

application/xml, text/xml

Sample:

<QuoteProductInboundDTO 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>
  <Product />
  <Quote>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>9</Id>
    <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>
    <Country>sample string 5</Country>
    <CustomerId>1</CustomerId>
    <EffectiveDate>2019-04-10T09:27:16.5162457-10:00</EffectiveDate>
    <LineOfBusiness>sample string 2</LineOfBusiness>
    <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: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>
    <QuoteNumber>sample string 8</QuoteNumber>
    <QuoteTerm>Unknown</QuoteTerm>
    <RateGuaranteeDate>2019-04-10T09:27:16.5162457-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 3</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <State>sample string 4</State>
    <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>
    <UnderwritingCompanyId>6</UnderwritingCompanyId>
    <UniversalAccountId>7</UniversalAccountId>
  </Quote>
</QuoteProductInboundDTO>

application/x-www-form-urlencoded

Sample:Sample not available.

Response Information

Resource Description

SimpleQuoteResponseDTO

Name Description Type Additional information
QuoteId integer None.
QuoteNumber string None.
ProductId integer None.
WarningMessages List of warning messages encountered while servicing request Collection of string None.

Response Formats

application/json, text/json

Sample:

{
  "QuoteId": 1,
  "QuoteNumber": "sample string 2",
  "ProductId": 1
}

application/xml, text/xml

Sample:

<SimpleQuoteResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>3</Id>
  <ProductId>1</ProductId>
  <QuoteId>1</QuoteId>
  <QuoteNumber>sample string 2</QuoteNumber>
</SimpleQuoteResponseDTO>

PUT v1/Quotes/issue?quoteNumber={quoteNumber}

Convert the specified quote to a policy

Request Information

URI Parameters

Name Description Type Additional information
quoteNumber quote number to convert string Required

Body Parameters

None.

Response Information

Resource Description

SimplePolicyResponseDTO

Name Description Type Additional information
QuoteId integer None.
QuoteNumber string None.
ProductId integer 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"
}

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>3</Id>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 2</PolicyNumber>
  <ProductId>1</ProductId>
</SimplePolicyResponseDTO>

Resources

userDto

Name Description Type Additional information
userID integer None.
userName string None.
password string None.
agentID integer None.

customerListDto

Name Description Type Additional information
totalCount integer None.
hasMore boolean None.
data Collection of customerDto

CustomerTypeEnum

Possible enumeration values:

Name Value Description
Personal 412
Commercial 413
Unknown 0

addressDto

Name Description Type Additional information
Id integer None.
Address1 string None.
Address2 string None.
City string None.
State string None.
Zipcode1 string None.
Zipcode2 string None.

quoteListDto

Name Description Type Additional information
totalCount integer None.
hasMore boolean None.
data Collection of quoteDto None.

HttpResponseMessage

Name Description Type Additional information
Version Version None.
Content HttpContent None.
StatusCode HttpStatusCode None.
ReasonPhrase string None.
Headers Collection of Object None.
RequestMessage HttpRequestMessage None.
IsSuccessStatusCode boolean None.

Version

Name Description Type Additional information
Major integer None.
Minor integer None.
Build integer None.
Revision integer None.
MajorRevision integer None.
MinorRevision integer None.

HttpContent

Name Description Type Additional information
Headers Collection of Object None.

HttpStatusCode

Possible enumeration values:

Name Value Description
Continue 100
SwitchingProtocols 101
OK 200
Created 201
Accepted 202
NonAuthoritativeInformation 203
NoContent 204
ResetContent 205
PartialContent 206
MultipleChoices 300
Ambiguous 300
MovedPermanently 301
Moved 301
Found 302
Redirect 302
SeeOther 303
RedirectMethod 303
NotModified 304
UseProxy 305
Unused 306
TemporaryRedirect 307
RedirectKeepVerb 307
BadRequest 400
Unauthorized 401
PaymentRequired 402
Forbidden 403
NotFound 404
MethodNotAllowed 405
NotAcceptable 406
ProxyAuthenticationRequired 407
RequestTimeout 408
Conflict 409
Gone 410
LengthRequired 411
PreconditionFailed 412
RequestEntityTooLarge 413
RequestUriTooLong 414
UnsupportedMediaType 415
RequestedRangeNotSatisfiable 416
ExpectationFailed 417
UpgradeRequired 426
InternalServerError 500
NotImplemented 501
BadGateway 502
ServiceUnavailable 503
GatewayTimeout 504
HttpVersionNotSupported 505

HttpRequestMessage

Name Description Type Additional information
Version Version None.
Content HttpContent None.
Method HttpMethod None.
RequestUri URI None.
Headers Collection of Object None.
Properties Dictionary of string [key] and Object [value] None.

HttpMethod

Name Description Type Additional information
Method string None.

commissionDto

Name Description Type Additional information
rate decimal number None.
lob string None.
state string None.
commissionOverride string None.
id integer None.
objectType string None.

agentDto

Name Description Type Additional information
Id integer None.
FirstName string None.
LastName string None.
CommercialName string None.
UserName string None.
Email string None.
Role string None.
ParentAgentId integer None.
IsActive boolean None.
Commissions Collection of commissionDto None.
ParentAgent agentDto None.

Conventions

Partial Updates (PATCH Requests)

PATCH requests can be used to performs updates of policies and quotes without sending the entire policy or quote object. This method is functionally equivalent to updating by sending the full object in a POST request.
A PATCH request is preferrable if the full object is not available, a small number of changes are being performed, or sending a full object is performance prohibitive.
The DRC API follows the JSON PATCH conventions for PATCH updates. For more details on the JSON PATCH standard, see here or RFC 6902

General Guidelines

Rule Example
Use sub-resources for relations GET /customers/711/quotes/ Returns a list of quotes for customer 711
GET /customers/711/quotes/4 Returns quote #4 for customer 711
Use a unique query parameter for all fields or a query language for filtering GET /customers?lastname=smith Returns a list of customers with lastname ‘smith’
GET /customers?dateOfBirth<=1/1/1990 Returns a list of customers born before 1/1/1990
Allow ascending and descending sorting over multiple fields GET /customers?sort=-lastname,+firstname
This returns a list of customers sorted by descending lastname and ascending firstname.
Use limit and offset. It is flexible for the user and common in leading databases. The default should be limit=20 and offset=0 GET /customers?offset=10&limit=5
To send the total entries back to the user use the custom HTTP header: X-Total-Count
Query string flags can be used for resource expansion when you know in advance that you are going to need the extra information GET /customers/711?expand=quotes
Use HTTP status codes:
200 – OK – Eyerything is working
201 – OK – New resource has been created
204 – OK – The resource was successfully deleted
400 – Bad Request – The request was invalid or cannot be served. The exact error should be explained in the error payload. E.g. „The JSON is not valid“
401 – Unauthorized – The request requires an user authentication
403 – Forbidden – The server understood the request, but is refusing it or the access is not allowed.
404 – Not found – There is no resource behind the URI.
500 – Internal Server Error – API developers should avoid this error. If an error occurs in the global catch blog, the stracktrace should be logged and not returned as response.