title: Agencies API v2.0 language_tabs:
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:
GET /agencies/v2.0/agency
Returns agency information for the agency user associated with the profile token included in the request.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $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": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "AgencyInfo represents the editable properties of an agency.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"address": {
"type": "string",
"description": "The primary address for the agency.",
"maxLength": 500,
"nullable": true
},
"alias": {
"type": "string",
"description": "An abbreviated or informal name of the agency.",
"maxLength": 255,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the agency.",
"maxLength": 255,
"nullable": true
},
"countryCode": {
"type": "string",
"description": "The country of the primary address for the agency.",
"maxLength": 2,
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform."
},
"faxNumber": {
"type": "string",
"description": "The fax number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"name": {
"type": "string",
"description": "The primary name that is used to identify the agency.",
"maxLength": 255,
"minLength": 1
},
"organizationalUnitId": {
"type": "string",
"description": "The unique Zywave identifier for the organization unit that the agency belongs to.",
"format": "guid"
},
"organizationId": {
"type": "string",
"description": "The unique Zywave identifier for the organization that the agency belongs to.",
"format": "guid"
},
"parentId": {
"type": "integer",
"description": "The unique Zywave identifier for a parent agency if this is a child agency.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the agency.",
"maxLength": 10,
"nullable": true
},
"subdivisionCode": {
"type": "string",
"description": "The state or province of the primary address for the agency.",
"maxLength": 4,
"nullable": true
},
"website": {
"type": "string",
"description": "The website for the agency.",
"maxLength": 255,
"nullable": true
}
}
},
{
"type": "object",
"description": "An agency is a standard tenant type within the Zywave platform and represents an insurance agency or related entity.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the agency.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of agencies that the profile identity is permitted to view. | AgencyCollection |
| 400 | Bad Request | none | string |
| 404 | Not Found | none | ProblemDetails |
GET /agencies/v2.0/agency/{id}
Returns agency information for the agency ID specified.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the desired agency |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "AgencyInfo represents the editable properties of an agency.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"address": {
"type": "string",
"description": "The primary address for the agency.",
"maxLength": 500,
"nullable": true
},
"alias": {
"type": "string",
"description": "An abbreviated or informal name of the agency.",
"maxLength": 255,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the agency.",
"maxLength": 255,
"nullable": true
},
"countryCode": {
"type": "string",
"description": "The country of the primary address for the agency.",
"maxLength": 2,
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform."
},
"faxNumber": {
"type": "string",
"description": "The fax number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"name": {
"type": "string",
"description": "The primary name that is used to identify the agency.",
"maxLength": 255,
"minLength": 1
},
"organizationalUnitId": {
"type": "string",
"description": "The unique Zywave identifier for the organization unit that the agency belongs to.",
"format": "guid"
},
"organizationId": {
"type": "string",
"description": "The unique Zywave identifier for the organization that the agency belongs to.",
"format": "guid"
},
"parentId": {
"type": "integer",
"description": "The unique Zywave identifier for a parent agency if this is a child agency.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the agency.",
"maxLength": 10,
"nullable": true
},
"subdivisionCode": {
"type": "string",
"description": "The state or province of the primary address for the agency.",
"maxLength": 4,
"nullable": true
},
"website": {
"type": "string",
"description": "The website for the agency.",
"maxLength": 255,
"nullable": true
}
}
},
{
"type": "object",
"description": "An agency is a standard tenant type within the Zywave platform and represents an insurance agency or related entity.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the agency.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The desired agency. | Agency |
| 404 | Not Found | none | ProblemDetails |
GET /agencies/v2.0/agencyuser
Searches for agency users.
See Zywave API search documentation for details.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The filter used to find the desired agency users |
| $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",
"description": "A value indicating whether the larger result set has more results."
},
"pageIndex": {
"type": "integer",
"description": "The index of the page reflected by the collection.",
"format": "int32",
"nullable": true
},
"pageSize": {
"type": "integer",
"description": "The size of the page reflected by the collection.",
"format": "int32",
"nullable": true
},
"skip": {
"type": "integer",
"description": "A value indicating how many of the previous values in the larger result set were omitted.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of records retrieved from larger result set.",
"format": "int32"
},
"totalCount": {
"type": "integer",
"description": "The total number of records in the larger result set.",
"format": "int32"
},
"items": {
"type": "array",
"description": "The records retrieved from the larger result set.",
"items": {
"allOf": [
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the user at the agency.",
"format": "int32"
},
"agencyId": {
"type": "integer",
"description": "The ID for the agency associated with this user.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was created.",
"format": "date-time",
"nullable": true
},
"createdUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who created the new AgencyUser.",
"format": "guid",
"nullable": true
},
"updatedDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was updated.",
"format": "date-time",
"nullable": true
},
"updatedUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who updated the new AgencyUser.",
"format": "guid",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The agency users that the profile identity is permitted to view. | PagedResultOfAgencyUser |
| 400 | Bad Request | none | string |
| 403 | Forbidden | none | ProblemDetails |
POST /agencies/v2.0/agencyuser
Creates an agency user.
Body parameter
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sendEmail | query | boolean | false | A value indicating whether to send an activation email to the new user (default is false). |
| body | body | AgencyUserInfo | true | Information for the user to be created. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The ID of the created user. | integer |
| 400 | Bad Request | none | ProblemDetails |
GET /agencies/v2.0/agencyuser/{id}
Returns agency user profile information for the agency user ID sent in the request.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the agency user |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the user at the agency.",
"format": "int32"
},
"agencyId": {
"type": "integer",
"description": "The ID for the agency associated with this user.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was created.",
"format": "date-time",
"nullable": true
},
"createdUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who created the new AgencyUser.",
"format": "guid",
"nullable": true
},
"updatedDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was updated.",
"format": "date-time",
"nullable": true
},
"updatedUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who updated the new AgencyUser.",
"format": "guid",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The desired agency user. | AgencyUser |
| 401 | Unauthorized | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /agencies/v2.0/agencyuser/{id}
Updates an existing agency user.
Body parameter
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the agency user to update |
| body | body | AgencyUserInfo | true | The information to update on the agency user. |
Example responses
400 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
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /agencies/v2.0/agencyuser/{id}
Deletes the agency user associated with the agency user ID.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the agency user to delete. |
Example responses
400 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
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /agencies/v2.0/agencyuser/{agencyUserId}/group
Returns groupId's associated with the agency user ID sent in the request.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agencyUserId | path | integer(int32) | true | The ID of the agency user |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The groupId's the agency user belongs to. | Inline |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /agencies/v2.0/agencyuser/{agencyUserId}/group
Updates the groups associated with the agency user Id in the request.
Body parameter
{
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agencyUserId | path | integer(int32) | true | The ID of the agency user |
| body | body | array[integer] | true | The group IDs to be associated with the agency user |
Example responses
400 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
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "AgencyInfo represents the editable properties of an agency.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"address": {
"type": "string",
"description": "The primary address for the agency.",
"maxLength": 500,
"nullable": true
},
"alias": {
"type": "string",
"description": "An abbreviated or informal name of the agency.",
"maxLength": 255,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the agency.",
"maxLength": 255,
"nullable": true
},
"countryCode": {
"type": "string",
"description": "The country of the primary address for the agency.",
"maxLength": 2,
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform."
},
"faxNumber": {
"type": "string",
"description": "The fax number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"name": {
"type": "string",
"description": "The primary name that is used to identify the agency.",
"maxLength": 255,
"minLength": 1
},
"organizationalUnitId": {
"type": "string",
"description": "The unique Zywave identifier for the organization unit that the agency belongs to.",
"format": "guid"
},
"organizationId": {
"type": "string",
"description": "The unique Zywave identifier for the organization that the agency belongs to.",
"format": "guid"
},
"parentId": {
"type": "integer",
"description": "The unique Zywave identifier for a parent agency if this is a child agency.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the agency.",
"maxLength": 10,
"nullable": true
},
"subdivisionCode": {
"type": "string",
"description": "The state or province of the primary address for the agency.",
"maxLength": 4,
"nullable": true
},
"website": {
"type": "string",
"description": "The website for the agency.",
"maxLength": 255,
"nullable": true
}
}
},
{
"type": "object",
"description": "An agency is a standard tenant type within the Zywave platform and represents an insurance agency or related entity.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the agency.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| items | [Agency] | false | none | none |
{
"allOf": [
{
"type": "object",
"description": "AgencyInfo represents the editable properties of an agency.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"address": {
"type": "string",
"description": "The primary address for the agency.",
"maxLength": 500,
"nullable": true
},
"alias": {
"type": "string",
"description": "An abbreviated or informal name of the agency.",
"maxLength": 255,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the agency.",
"maxLength": 255,
"nullable": true
},
"countryCode": {
"type": "string",
"description": "The country of the primary address for the agency.",
"maxLength": 2,
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform."
},
"faxNumber": {
"type": "string",
"description": "The fax number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"name": {
"type": "string",
"description": "The primary name that is used to identify the agency.",
"maxLength": 255,
"minLength": 1
},
"organizationalUnitId": {
"type": "string",
"description": "The unique Zywave identifier for the organization unit that the agency belongs to.",
"format": "guid"
},
"organizationId": {
"type": "string",
"description": "The unique Zywave identifier for the organization that the agency belongs to.",
"format": "guid"
},
"parentId": {
"type": "integer",
"description": "The unique Zywave identifier for a parent agency if this is a child agency.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the agency.",
"maxLength": 10,
"nullable": true
},
"subdivisionCode": {
"type": "string",
"description": "The state or province of the primary address for the agency.",
"maxLength": 4,
"nullable": true
},
"website": {
"type": "string",
"description": "The website for the agency.",
"maxLength": 255,
"nullable": true
}
}
},
{
"type": "object",
"description": "An agency is a standard tenant type within the Zywave platform and represents an insurance agency or related entity.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the agency.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AgencyInfo | false | none | AgencyInfo represents the editable properties of an agency. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | An agency is a standard tenant type within the Zywave platform and represents an insurance agency or related entity. |
| » id | integer(int32) | false | none | The unique Zywave identifier for the agency. |
{
"type": "object",
"description": "AgencyInfo represents the editable properties of an agency.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"address": {
"type": "string",
"description": "The primary address for the agency.",
"maxLength": 500,
"nullable": true
},
"alias": {
"type": "string",
"description": "An abbreviated or informal name of the agency.",
"maxLength": 255,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the agency.",
"maxLength": 255,
"nullable": true
},
"countryCode": {
"type": "string",
"description": "The country of the primary address for the agency.",
"maxLength": 2,
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform."
},
"faxNumber": {
"type": "string",
"description": "The fax number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"name": {
"type": "string",
"description": "The primary name that is used to identify the agency.",
"maxLength": 255,
"minLength": 1
},
"organizationalUnitId": {
"type": "string",
"description": "The unique Zywave identifier for the organization unit that the agency belongs to.",
"format": "guid"
},
"organizationId": {
"type": "string",
"description": "The unique Zywave identifier for the organization that the agency belongs to.",
"format": "guid"
},
"parentId": {
"type": "integer",
"description": "The unique Zywave identifier for a parent agency if this is a child agency.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number for the agency.",
"format": "phone",
"maxLength": 15,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the agency.",
"maxLength": 10,
"nullable": true
},
"subdivisionCode": {
"type": "string",
"description": "The state or province of the primary address for the agency.",
"maxLength": 4,
"nullable": true
},
"website": {
"type": "string",
"description": "The website for the agency.",
"maxLength": 255,
"nullable": true
}
}
}
AgencyInfo represents the editable properties of an agency.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address | string|null | false | none | The primary address for the agency. |
| alias | string|null | false | none | An abbreviated or informal name of the agency. |
| city | string|null | false | none | The city of the primary address for the agency. |
| countryCode | string|null | false | none | The country of the primary address for the agency. |
| isEnabled | boolean | false | none | Determines whether the agency is an active agency. If the agency is not active they will not have access to functionality throughout the Zywave platform. |
| faxNumber | string(phone)|null | false | none | The fax number for the agency. |
| name | string | true | none | The primary name that is used to identify the agency. |
| organizationalUnitId | string(guid) | false | none | The unique Zywave identifier for the organization unit that the agency belongs to. |
| organizationId | string(guid) | false | none | The unique Zywave identifier for the organization that the agency belongs to. |
| parentId | integer(int32)|null | false | none | The unique Zywave identifier for a parent agency if this is a child agency. |
| phoneNumber | string(phone)|null | false | none | The primary phone number for the agency. |
| postalCode | string|null | false | none | The zip code or postal code of the primary address for the agency. |
| subdivisionCode | string|null | false | none | The state or province of the primary address for the agency. |
| website | string|null | false | none | The website for the agency. |
{
"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
}
}
}
| 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 |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean",
"description": "A value indicating whether the larger result set has more results."
},
"pageIndex": {
"type": "integer",
"description": "The index of the page reflected by the collection.",
"format": "int32",
"nullable": true
},
"pageSize": {
"type": "integer",
"description": "The size of the page reflected by the collection.",
"format": "int32",
"nullable": true
},
"skip": {
"type": "integer",
"description": "A value indicating how many of the previous values in the larger result set were omitted.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of records retrieved from larger result set.",
"format": "int32"
},
"totalCount": {
"type": "integer",
"description": "The total number of records in the larger result set.",
"format": "int32"
},
"items": {
"type": "array",
"description": "The records retrieved from the larger result set.",
"items": {
"allOf": [
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the user at the agency.",
"format": "int32"
},
"agencyId": {
"type": "integer",
"description": "The ID for the agency associated with this user.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was created.",
"format": "date-time",
"nullable": true
},
"createdUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who created the new AgencyUser.",
"format": "guid",
"nullable": true
},
"updatedDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was updated.",
"format": "date-time",
"nullable": true
},
"updatedUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who updated the new AgencyUser.",
"format": "guid",
"nullable": true
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | A value indicating whether the larger result set has more results. |
| pageIndex | integer(int32)|null | false | none | The index of the page reflected by the collection. |
| pageSize | integer(int32)|null | false | none | The size of the page reflected by the collection. |
| skip | integer(int32) | false | none | A value indicating how many of the previous values in the larger result set were omitted. |
| take | integer(int32) | false | none | The number of records retrieved from larger result set. |
| totalCount | integer(int32) | false | none | The total number of records in the larger result set. |
| items | [AgencyUser] | false | none | The records retrieved from the larger result set. |
{
"allOf": [
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the user at the agency.",
"format": "int32"
},
"agencyId": {
"type": "integer",
"description": "The ID for the agency associated with this user.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was created.",
"format": "date-time",
"nullable": true
},
"createdUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who created the new AgencyUser.",
"format": "guid",
"nullable": true
},
"updatedDateTime": {
"type": "string",
"description": "The datetime in which an AgencyUser was updated.",
"format": "date-time",
"nullable": true
},
"updatedUserPrincipalId": {
"type": "string",
"description": "The user principal Id of the user who updated the new AgencyUser.",
"format": "guid",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AgencyUserInfo | false | none | AgencyUserInfo represents the editable properties of an agency user. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user. |
| » id | integer(int32) | false | none | The unique Zywave identifier for the user at the agency. |
| » agencyId | integer(int32) | false | none | The ID for the agency associated with this user. |
| » createdDateTime | string(date-time)|null | false | none | The datetime in which an AgencyUser was created. |
| » createdUserPrincipalId | string(guid)|null | false | none | The user principal Id of the user who created the new AgencyUser. |
| » updatedDateTime | string(date-time)|null | false | none | The datetime in which an AgencyUser was updated. |
| » updatedUserPrincipalId | string(guid)|null | false | none | The user principal Id of the user who updated the new AgencyUser. |
{
"type": "object",
"description": "AgencyUserInfo represents the editable properties of an agency user.",
"additionalProperties": false,
"required": [
"firstName",
"lastName"
],
"properties": {
"biography": {
"type": "string",
"description": "A written biography about the user.",
"maxLength": 1000,
"nullable": true
},
"designation": {
"type": "string",
"description": "A list of professional designations earned by the user.",
"maxLength": 50,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The primary emails address of the user.",
"maxLength": 100,
"nullable": true
},
"externalEmployeeId": {
"type": "string",
"description": "An identifier for correlation with an external employee management system",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The primary fax number of the user.",
"maxLength": 20,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"maxLength": 50,
"minLength": 1
},
"isAdministrator": {
"type": "boolean",
"description": "Denotes whether the user has full administrative privileges for the specific agency the are associated with."
},
"isEnabled": {
"type": "boolean",
"description": "Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with."
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"maxLength": 50,
"minLength": 1
},
"linesOfBusiness": {
"type": "array",
"description": "Specifies the lines of business within the agency the user is associated with.",
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
},
"middleInitial": {
"type": "string",
"description": "The middle initial of the user.",
"maxLength": 2,
"nullable": true
},
"npn": {
"type": "string",
"description": "The national produce number for the user at this agency.",
"maxLength": 10,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The primary phone number of the user.",
"maxLength": 20,
"nullable": true
},
"primaryRole": {
"description": "The primary role of the user at the agency.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
]
},
"salutation": {
"type": "string",
"description": "The greeting associated with the user.",
"maxLength": 8,
"nullable": true
},
"title": {
"type": "string",
"description": "The job title of the user at the agency.",
"maxLength": 100,
"nullable": true
}
}
}
AgencyUserInfo represents the editable properties of an agency user.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| biography | string|null | false | none | A written biography about the user. |
| designation | string|null | false | none | A list of professional designations earned by the user. |
| emailAddress | string|null | false | none | The primary emails address of the user. |
| externalEmployeeId | string|null | false | none | An identifier for correlation with an external employee management system |
| faxNumber | string|null | false | none | The primary fax number of the user. |
| firstName | string | true | none | The first name of the user. |
| isAdministrator | boolean | false | none | Denotes whether the user has full administrative privileges for the specific agency the are associated with. |
| isEnabled | boolean | false | none | Determine whether the user is an active user. If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with. |
| lastName | string | true | none | The last name of the user. |
| linesOfBusiness | [LineOfBusiness] | false | none | Specifies the lines of business within the agency the user is associated with. |
| middleInitial | string|null | false | none | The middle initial of the user. |
| npn | string|null | false | none | The national produce number for the user at this agency. |
| phoneNumber | string|null | false | none | The primary phone number of the user. |
| primaryRole | AgencyUserRole | false | none | The primary role of the user at the agency. |
| salutation | string|null | false | none | The greeting associated with the user. |
| title | string|null | false | none | The job title of the user at the agency. |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
],
"enum": [
"None",
"Benefits",
"Financial",
"PersonalLines",
"PropertyCasualty"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Benefits |
| anonymous | Financial |
| anonymous | PersonalLines |
| anonymous | PropertyCasualty |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
],
"enum": [
"None",
"Executive",
"Sales",
"ClientServices",
"InformationTechnology",
"Finance",
"HumanResources"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Executive |
| anonymous | Sales |
| anonymous | ClientServices |
| anonymous | InformationTechnology |
| anonymous | Finance |
| anonymous | HumanResources |