GET v1/Carriers/Summary

Get a list of carriers, their addresses and respective parent carriers.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of carrier summaries

Collection of CarrierSummaryDTO

Name	Description	Type	Additional information
CarrierID	Carrier table primary key	integer	None.
CarrierName	Carrier display name	string	None.
Status	A = Active, I = Inactive, D = Deleted	string	None.
NAIC	NAIC code	string	None.
BestRatingCode	AM Best rating code	string	None.
PremiumSent	Premium sent flag	string	None.
LastModified	Date last modified as ISO string — empty string if never modified	string	None.
ParentCarrierID	Parent carrier entity ID — null if no parent	integer	None.
ParentCarrierName	Parent carrier name — null if no parent	string	None.
FEIN	Federal Employer Identification Number	string	None.
DBA	Doing Business As name	string	None.
CreatedOn	Created on date as ISO string	string	None.
AppCreated	Source application that created the record	string	None.
Addresses	Carrier addresses	Collection of AddressDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CarrierID": 1,
    "CarrierName": "sample string 2",
    "Status": "sample string 3",
    "NAIC": "sample string 4",
    "BestRatingCode": "sample string 5",
    "PremiumSent": "sample string 6",
    "LastModified": "sample string 7",
    "ParentCarrierID": 1,
    "ParentCarrierName": "sample string 8",
    "FEIN": "sample string 9",
    "DBA": "sample string 10",
    "CreatedOn": "sample string 11",
    "AppCreated": "sample string 12",
    "Addresses": [
      {
        "AddressID": 1,
        "EntityID": 2,
        "AddressTypeID": "sample string 3",
        "AddressType": {
          "AddressTypeID": "A",
          "Name": "sample string 2"
        },
        "Line1": "sample string 4",
        "Line2": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "County": "sample string 8",
        "CountryCode": "sample string 9",
        "Province": "sample string 10",
        "Zip": "sample string 11",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "Notes": "sample string 12",
        "RowSource": "sample string 13",
        "isPreferred": true,
        "AddressString": "sample string 14"
      },
      {
        "AddressID": 1,
        "EntityID": 2,
        "AddressTypeID": "sample string 3",
        "AddressType": {
          "AddressTypeID": "A",
          "Name": "sample string 2"
        },
        "Line1": "sample string 4",
        "Line2": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "County": "sample string 8",
        "CountryCode": "sample string 9",
        "Province": "sample string 10",
        "Zip": "sample string 11",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "Notes": "sample string 12",
        "RowSource": "sample string 13",
        "isPreferred": true,
        "AddressString": "sample string 14"
      }
    ]
  },
  {
    "CarrierID": 1,
    "CarrierName": "sample string 2",
    "Status": "sample string 3",
    "NAIC": "sample string 4",
    "BestRatingCode": "sample string 5",
    "PremiumSent": "sample string 6",
    "LastModified": "sample string 7",
    "ParentCarrierID": 1,
    "ParentCarrierName": "sample string 8",
    "FEIN": "sample string 9",
    "DBA": "sample string 10",
    "CreatedOn": "sample string 11",
    "AppCreated": "sample string 12",
    "Addresses": [
      {
        "AddressID": 1,
        "EntityID": 2,
        "AddressTypeID": "sample string 3",
        "AddressType": {
          "AddressTypeID": "A",
          "Name": "sample string 2"
        },
        "Line1": "sample string 4",
        "Line2": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "County": "sample string 8",
        "CountryCode": "sample string 9",
        "Province": "sample string 10",
        "Zip": "sample string 11",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "Notes": "sample string 12",
        "RowSource": "sample string 13",
        "isPreferred": true,
        "AddressString": "sample string 14"
      },
      {
        "AddressID": 1,
        "EntityID": 2,
        "AddressTypeID": "sample string 3",
        "AddressType": {
          "AddressTypeID": "A",
          "Name": "sample string 2"
        },
        "Line1": "sample string 4",
        "Line2": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "County": "sample string 8",
        "CountryCode": "sample string 9",
        "Province": "sample string 10",
        "Zip": "sample string 11",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "Notes": "sample string 12",
        "RowSource": "sample string 13",
        "isPreferred": true,
        "AddressString": "sample string 14"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCarrierSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <CarrierSummaryDTO>
    <Addresses>
      <AddressDTO>
        <AddressID>1</AddressID>
        <AddressString>sample string 14</AddressString>
        <AddressType>
          <AddressTypeID>65</AddressTypeID>
          <Name>sample string 2</Name>
        </AddressType>
        <AddressTypeID>sample string 3</AddressTypeID>
        <City>sample string 6</City>
        <CountryCode>sample string 9</CountryCode>
        <County>sample string 8</County>
        <EntityID>2</EntityID>
        <Latitude>1.1</Latitude>
        <Line1>sample string 4</Line1>
        <Line2>sample string 5</Line2>
        <Longitude>1.1</Longitude>
        <Notes>sample string 12</Notes>
        <Province>sample string 10</Province>
        <RowSource>sample string 13</RowSource>
        <State>sample string 7</State>
        <Zip>sample string 11</Zip>
        <isPreferred>true</isPreferred>
      </AddressDTO>
      <AddressDTO>
        <AddressID>1</AddressID>
        <AddressString>sample string 14</AddressString>
        <AddressType>
          <AddressTypeID>65</AddressTypeID>
          <Name>sample string 2</Name>
        </AddressType>
        <AddressTypeID>sample string 3</AddressTypeID>
        <City>sample string 6</City>
        <CountryCode>sample string 9</CountryCode>
        <County>sample string 8</County>
        <EntityID>2</EntityID>
        <Latitude>1.1</Latitude>
        <Line1>sample string 4</Line1>
        <Line2>sample string 5</Line2>
        <Longitude>1.1</Longitude>
        <Notes>sample string 12</Notes>
        <Province>sample string 10</Province>
        <RowSource>sample string 13</RowSource>
        <State>sample string 7</State>
        <Zip>sample string 11</Zip>
        <isPreferred>true</isPreferred>
      </AddressDTO>
    </Addresses>
    <AppCreated>sample string 12</AppCreated>
    <BestRatingCode>sample string 5</BestRatingCode>
    <CarrierID>1</CarrierID>
    <CarrierName>sample string 2</CarrierName>
    <CreatedOn>sample string 11</CreatedOn>
    <DBA>sample string 10</DBA>
    <FEIN>sample string 9</FEIN>
    <LastModified>sample string 7</LastModified>
    <NAIC>sample string 4</NAIC>
    <ParentCarrierID>1</ParentCarrierID>
    <ParentCarrierName>sample string 8</ParentCarrierName>
    <PremiumSent>sample string 6</PremiumSent>
    <Status>sample string 3</Status>
  </CarrierSummaryDTO>
  <CarrierSummaryDTO>
    <Addresses>
      <AddressDTO>
        <AddressID>1</AddressID>
        <AddressString>sample string 14</AddressString>
        <AddressType>
          <AddressTypeID>65</AddressTypeID>
          <Name>sample string 2</Name>
        </AddressType>
        <AddressTypeID>sample string 3</AddressTypeID>
        <City>sample string 6</City>
        <CountryCode>sample string 9</CountryCode>
        <County>sample string 8</County>
        <EntityID>2</EntityID>
        <Latitude>1.1</Latitude>
        <Line1>sample string 4</Line1>
        <Line2>sample string 5</Line2>
        <Longitude>1.1</Longitude>
        <Notes>sample string 12</Notes>
        <Province>sample string 10</Province>
        <RowSource>sample string 13</RowSource>
        <State>sample string 7</State>
        <Zip>sample string 11</Zip>
        <isPreferred>true</isPreferred>
      </AddressDTO>
      <AddressDTO>
        <AddressID>1</AddressID>
        <AddressString>sample string 14</AddressString>
        <AddressType>
          <AddressTypeID>65</AddressTypeID>
          <Name>sample string 2</Name>
        </AddressType>
        <AddressTypeID>sample string 3</AddressTypeID>
        <City>sample string 6</City>
        <CountryCode>sample string 9</CountryCode>
        <County>sample string 8</County>
        <EntityID>2</EntityID>
        <Latitude>1.1</Latitude>
        <Line1>sample string 4</Line1>
        <Line2>sample string 5</Line2>
        <Longitude>1.1</Longitude>
        <Notes>sample string 12</Notes>
        <Province>sample string 10</Province>
        <RowSource>sample string 13</RowSource>
        <State>sample string 7</State>
        <Zip>sample string 11</Zip>
        <isPreferred>true</isPreferred>
      </AddressDTO>
    </Addresses>
    <AppCreated>sample string 12</AppCreated>
    <BestRatingCode>sample string 5</BestRatingCode>
    <CarrierID>1</CarrierID>
    <CarrierName>sample string 2</CarrierName>
    <CreatedOn>sample string 11</CreatedOn>
    <DBA>sample string 10</DBA>
    <FEIN>sample string 9</FEIN>
    <LastModified>sample string 7</LastModified>
    <NAIC>sample string 4</NAIC>
    <ParentCarrierID>1</ParentCarrierID>
    <ParentCarrierName>sample string 8</ParentCarrierName>
    <PremiumSent>sample string 6</PremiumSent>
    <Status>sample string 3</Status>
  </CarrierSummaryDTO>
</ArrayOfCarrierSummaryDTO>