---

title: Carriers API language_tabs:

• shell: Shell
• http: HTTP
• javascript: JavaScript
• javascript--nodejs: Node.JS
• ruby: Ruby
• python: Python
• java: Java
• go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

---

Carriers API v2.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

• https://api.zywave.com

Authentication

Carrier

Carrier_GetCarrier

GET /carriers/v2.0/carrier/{id}

Returns the carrier information for the carrier id specified.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The Carrier id.

Example responses

200 Response

{
  "allOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the carrier.",
          "maxLength": 100,
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the carrier.",
          "maxLength": 100,
          "nullable": true
        },
        "groupNumber": {
          "type": "integer",
          "description": "NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.",
          "format": "int32",
          "nullable": true
        },
        "isActive": {
          "type": "boolean",
          "description": "Indicates whether the carrier is active."
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the carrier.",
          "format": "int32"
        }
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Carrier
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

Carrier_SearchCarriers

GET /carriers/v2.0/carrier

Returns list of carrier information for all carriers.

The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.

• Id
• Name
• DisplayName
• GroupNumber
• IsActive

See the Zywave API search documentation for more details about using OData search.

Parameters

Name	In	Type	Required	Description
$filter	query	string	false	The filter used to find the desired carriers
$orderBy	query	string	false	The properties used to order the search results
$skip	query	integer(int32)	false	The number of records in the result set to skip
$top	query	integer(int32)	false	The maximum number of records after the first skip records to take from the remaining result set

Example responses

200 Response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean"
    },
    "pageIndex": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "skip": {
      "type": "integer",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the carrier.",
                "maxLength": 100,
                "minLength": 1
              },
              "displayName": {
                "type": "string",
                "description": "The display name of the carrier.",
                "maxLength": 100,
                "nullable": true
              },
              "groupNumber": {
                "type": "integer",
                "description": "NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.",
                "format": "int32",
                "nullable": true
              },
              "isActive": {
                "type": "boolean",
                "description": "Indicates whether the carrier is active."
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the carrier.",
                "format": "int32"
              }
            }
          }
        ]
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The carriers that fulfill the search criteria on the request.	PagedResultOfCarrier
400	Bad Request	none	ValidationProblemDetails
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails

CarrierCompany

CarrierCompany_GetCarrierCompany

GET /carriers/v2.0/carriercompany/{id}

Returns the carrier company for the carrier company id specified.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The carrier company id.

Example responses

200 Response

{
  "allOf": [
    {
      "type": "object",
      "description": "CarrierCompanyInfo\n            ",
      "additionalProperties": false,
      "required": [
        "name",
        "carrierId",
        "countryCode",
        "isActive"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the carrier company.",
          "maxLength": 100,
          "minLength": 1
        },
        "carrierId": {
          "type": "integer",
          "description": "The identifier for the carrier that is tied to the carrier company record.",
          "format": "int32"
        },
        "naic": {
          "type": "string",
          "description": "NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.",
          "maxLength": 50,
          "nullable": true
        },
        "subdivisionCode": {
          "type": "string",
          "description": "The state that applies to the carrier company.",
          "maxLength": 2,
          "nullable": true
        },
        "countryCode": {
          "type": "string",
          "description": "The country that applies to the carrier company.",
          "maxLength": 2,
          "minLength": 1
        },
        "isActive": {
          "type": "boolean",
          "description": "Indicates whether the carrier company is active."
        },
        "isPreferred": {
          "type": "boolean",
          "description": "Indicates whether the carrier company is a preferred carrier company for your agency."
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the carrier company.",
          "maxLength": 100,
          "nullable": true
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the carrier company.",
          "format": "int32"
        }
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	none	CarrierCompany
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

CarrierCompany_SearchCarrierCompanies

GET /carriers/v2.0/carriercompany

Returns list of carrier company information for all carrier companies.

The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.

• Id
• Name
• CarrierId
• Naic
• SubdivisionCode
• CountryCode
• IsActive
• IsPreferred
• DisplayName

See the Zywave API search documentation for more details about using OData search.

Parameters

Name	In	Type	Required	Description
$filter	query	string	false	The filter used to find the desired carriers
$orderBy	query	string	false	The properties used to order the search results
$skip	query	integer(int32)	false	The number of records in the result set to skip
$top	query	integer(int32)	false	The maximum number of records after the first skip records to take from the remaining result set

Example responses

200 Response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean"
    },
    "pageIndex": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "skip": {
      "type": "integer",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "description": "CarrierCompanyInfo\n            ",
            "additionalProperties": false,
            "required": [
              "name",
              "carrierId",
              "countryCode",
              "isActive"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the carrier company.",
                "maxLength": 100,
                "minLength": 1
              },
              "carrierId": {
                "type": "integer",
                "description": "The identifier for the carrier that is tied to the carrier company record.",
                "format": "int32"
              },
              "naic": {
                "type": "string",
                "description": "NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.",
                "maxLength": 50,
                "nullable": true
              },
              "subdivisionCode": {
                "type": "string",
                "description": "The state that applies to the carrier company.",
                "maxLength": 2,
                "nullable": true
              },
              "countryCode": {
                "type": "string",
                "description": "The country that applies to the carrier company.",
                "maxLength": 2,
                "minLength": 1
              },
              "isActive": {
                "type": "boolean",
                "description": "Indicates whether the carrier company is active."
              },
              "isPreferred": {
                "type": "boolean",
                "description": "Indicates whether the carrier company is a preferred carrier company for your agency."
              },
              "displayName": {
                "type": "string",
                "description": "The display name for the carrier company.",
                "maxLength": 100,
                "nullable": true
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the carrier company.",
                "format": "int32"
              }
            }
          }
        ]
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The carriers that fulfill the search criteria on the request.	PagedResultOfCarrierCompany
400	Bad Request	none	ValidationProblemDetails
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails

CarrierCompany_SetPreferred

PUT /carriers/v2.0/carriercompany/{id}/setpreferred

Sets a carrier company as a preferred carrier company for an agency.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The carrier company id.

Example responses

401 Response

{
  "type": "object",
  "additionalProperties": {
    "nullable": true
  },
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	A 204 No Content response.	None
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

CarrierCompany_ClearPreferred

PUT /carriers/v2.0/carriercompany/{id}/clearpreferred

Clears a carrier company from being a preferred carrier company for an agency.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The carrier company id.

Example responses

401 Response

{
  "type": "object",
  "additionalProperties": {
    "nullable": true
  },
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	A 204 No Content response.	None
401	Unauthorized	none	ProblemDetails
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

Schemas

CarrierCompany

{
  "allOf": [
    {
      "type": "object",
      "description": "CarrierCompanyInfo\n            ",
      "additionalProperties": false,
      "required": [
        "name",
        "carrierId",
        "countryCode",
        "isActive"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the carrier company.",
          "maxLength": 100,
          "minLength": 1
        },
        "carrierId": {
          "type": "integer",
          "description": "The identifier for the carrier that is tied to the carrier company record.",
          "format": "int32"
        },
        "naic": {
          "type": "string",
          "description": "NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.",
          "maxLength": 50,
          "nullable": true
        },
        "subdivisionCode": {
          "type": "string",
          "description": "The state that applies to the carrier company.",
          "maxLength": 2,
          "nullable": true
        },
        "countryCode": {
          "type": "string",
          "description": "The country that applies to the carrier company.",
          "maxLength": 2,
          "minLength": 1
        },
        "isActive": {
          "type": "boolean",
          "description": "Indicates whether the carrier company is active."
        },
        "isPreferred": {
          "type": "boolean",
          "description": "Indicates whether the carrier company is a preferred carrier company for your agency."
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the carrier company.",
          "maxLength": 100,
          "nullable": true
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the carrier company.",
          "format": "int32"
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	CarrierCompanyInfo	false	none	CarrierCompanyInfo

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» id	integer(int32)	false	none	The unique Zywave identifier for the carrier company.

CarrierCompanyInfo

{
  "type": "object",
  "description": "CarrierCompanyInfo\n            ",
  "additionalProperties": false,
  "required": [
    "name",
    "carrierId",
    "countryCode",
    "isActive"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the carrier company.",
      "maxLength": 100,
      "minLength": 1
    },
    "carrierId": {
      "type": "integer",
      "description": "The identifier for the carrier that is tied to the carrier company record.",
      "format": "int32"
    },
    "naic": {
      "type": "string",
      "description": "NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.",
      "maxLength": 50,
      "nullable": true
    },
    "subdivisionCode": {
      "type": "string",
      "description": "The state that applies to the carrier company.",
      "maxLength": 2,
      "nullable": true
    },
    "countryCode": {
      "type": "string",
      "description": "The country that applies to the carrier company.",
      "maxLength": 2,
      "minLength": 1
    },
    "isActive": {
      "type": "boolean",
      "description": "Indicates whether the carrier company is active."
    },
    "isPreferred": {
      "type": "boolean",
      "description": "Indicates whether the carrier company is a preferred carrier company for your agency."
    },
    "displayName": {
      "type": "string",
      "description": "The display name for the carrier company.",
      "maxLength": 100,
      "nullable": true
    }
  }
}

*CarrierCompanyInfo *

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the carrier company.
carrierId	integer(int32)	true	none	The identifier for the carrier that is tied to the carrier company record.
naic	string|null	false	none	NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.
subdivisionCode	string|null	false	none	The state that applies to the carrier company.
countryCode	string	true	none	The country that applies to the carrier company.
isActive	boolean	true	none	Indicates whether the carrier company is active.
isPreferred	boolean	false	none	Indicates whether the carrier company is a preferred carrier company for your agency.
displayName	string|null	false	none	The display name for the carrier company.

ProblemDetails

{
  "type": "object",
  "additionalProperties": {
    "nullable": true
  },
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none
type	string|null	false	none	none
title	string|null	false	none	none
status	integer(int32)|null	false	none	none
detail	string|null	false	none	none
instance	string|null	false	none	none

PagedResultOfCarrierCompany

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean"
    },
    "pageIndex": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "skip": {
      "type": "integer",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "description": "CarrierCompanyInfo\n            ",
            "additionalProperties": false,
            "required": [
              "name",
              "carrierId",
              "countryCode",
              "isActive"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the carrier company.",
                "maxLength": 100,
                "minLength": 1
              },
              "carrierId": {
                "type": "integer",
                "description": "The identifier for the carrier that is tied to the carrier company record.",
                "format": "int32"
              },
              "naic": {
                "type": "string",
                "description": "NAIC's (National Association of Insurance Commissioners) Company Number. The unique NAIC identifier for the carrier company.",
                "maxLength": 50,
                "nullable": true
              },
              "subdivisionCode": {
                "type": "string",
                "description": "The state that applies to the carrier company.",
                "maxLength": 2,
                "nullable": true
              },
              "countryCode": {
                "type": "string",
                "description": "The country that applies to the carrier company.",
                "maxLength": 2,
                "minLength": 1
              },
              "isActive": {
                "type": "boolean",
                "description": "Indicates whether the carrier company is active."
              },
              "isPreferred": {
                "type": "boolean",
                "description": "Indicates whether the carrier company is a preferred carrier company for your agency."
              },
              "displayName": {
                "type": "string",
                "description": "The display name for the carrier company.",
                "maxLength": 100,
                "nullable": true
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the carrier company.",
                "format": "int32"
              }
            }
          }
        ]
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
hasMoreResults	boolean	false	none	none
pageIndex	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none
skip	integer(int32)	false	none	none
take	integer(int32)	false	none	none
totalCount	integer(int32)	false	none	none
items	[CarrierCompany]	false	none	none

ValidationProblemDetails

{
  "allOf": [
    {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": {
            "nullable": true
          },
          "properties": {
            "type": {
              "type": "string",
              "nullable": true
            },
            "title": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "detail": {
              "type": "string",
              "nullable": true
            },
            "instance": {
              "type": "string",
              "nullable": true
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "nullable": true
          },
          "properties": {
            "errors": {
              "type": "object",
              "additionalProperties": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "nullable": true
      },
      "properties": {
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	HttpValidationProblemDetails	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» additionalProperties	any	false	none	none
» errors	object	false	none	none
»» additionalProperties	[string]	false	none	none

HttpValidationProblemDetails

{
  "allOf": [
    {
      "type": "object",
      "additionalProperties": {
        "nullable": true
      },
      "properties": {
        "type": {
          "type": "string",
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32",
          "nullable": true
        },
        "detail": {
          "type": "string",
          "nullable": true
        },
        "instance": {
          "type": "string",
          "nullable": true
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": {
        "nullable": true
      },
      "properties": {
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ProblemDetails	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» additionalProperties	any	false	none	none
» errors	object	false	none	none
»» additionalProperties	[string]	false	none	none

Carrier

{
  "allOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the carrier.",
          "maxLength": 100,
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the carrier.",
          "maxLength": 100,
          "nullable": true
        },
        "groupNumber": {
          "type": "integer",
          "description": "NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.",
          "format": "int32",
          "nullable": true
        },
        "isActive": {
          "type": "boolean",
          "description": "Indicates whether the carrier is active."
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the carrier.",
          "format": "int32"
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	CarrierInfo	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» id	integer(int32)	false	none	The unique Zywave identifier for the carrier.

CarrierInfo

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the carrier.",
      "maxLength": 100,
      "minLength": 1
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the carrier.",
      "maxLength": 100,
      "nullable": true
    },
    "groupNumber": {
      "type": "integer",
      "description": "NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.",
      "format": "int32",
      "nullable": true
    },
    "isActive": {
      "type": "boolean",
      "description": "Indicates whether the carrier is active."
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the carrier.
displayName	string|null	false	none	The display name of the carrier.
groupNumber	integer(int32)|null	false	none	NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.
isActive	boolean	false	none	Indicates whether the carrier is active.

PagedResultOfCarrier

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean"
    },
    "pageIndex": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "skip": {
      "type": "integer",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the carrier.",
                "maxLength": 100,
                "minLength": 1
              },
              "displayName": {
                "type": "string",
                "description": "The display name of the carrier.",
                "maxLength": 100,
                "nullable": true
              },
              "groupNumber": {
                "type": "integer",
                "description": "NAIC's (National Association of Insurance Commissioners) Group Number. The unique NAIC identifier for the carrier.",
                "format": "int32",
                "nullable": true
              },
              "isActive": {
                "type": "boolean",
                "description": "Indicates whether the carrier is active."
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the carrier.",
                "format": "int32"
              }
            }
          }
        ]
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
hasMoreResults	boolean	false	none	none
pageIndex	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none
skip	integer(int32)	false	none	none
take	integer(int32)	false	none	none
totalCount	integer(int32)	false	none	none
items	[Carrier]	false	none	none