Connectors Reference
Impexium is the premier association management software solution for nonprofits and member-based organizations.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Add Individual |
|
|
Add-Activity (string id, [internal]string Content-Type, [Optional]Add-ActivityParameterBody body) |
Add Activity |
|
Find Individual by ID or Email or Record Number |
|
|
Add Individual to Committee |
|
|
Add-Organization ([internal]string Content-Type, [Optional]Add-OrganizationParameterBody body) |
Add Organization |
|
Add Relationship to Individual |
|
|
Update Organization |
|
|
List of all custom fields |
|
|
Find Customer by Phone Number |
|
|
Update Custom Field Value |
|
Name |
Summary |
|
When-Individual-Created ([internal]string Content-Type, When-Individual-CreatedParameterBody body) |
Individual Created |
|
When-product-purchased ([internal]string Content-Type, When-product-purchasedParameterBody body) |
When Product is Purchased |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Add Individual
Description: Adds an Individual
Syntax:
Impexium.Add-Individual ([advanced][Optional]string createUser, [internal]string Content-Type, [Optional]Add-IndividualParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
createUser |
string (Create User.)Values: [True, False] |
Choose True if a user account should be created when the individual is created. |
False |
|
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Type:IndividualData
Summary: Add Activity
Description: Add Activity
Syntax:
Impexium.Add-Activity (string id, [internal]string Content-Type, [Optional]Add-ActivityParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Individual ID) |
Individual ID |
True |
|
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Type:Add-ActivityResponse
Summary: Find Individual by ID or Email or Record Number
Description: Find Individual by ID or Email
Syntax:
Impexium.Find-Individual-IDOrEmail (string idOrRecordNumberOrEmail, [internal]integer pageNumber, [internal]string IncludeDetails, [internal]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
idOrRecordNumberOrEmail |
string (ID Or Record Number Or Email) |
ID Or Record Number Or Email |
True |
|
|
pageNumber |
integer
|
|
True |
|
|
IncludeDetails |
string
|
|
True |
|
|
Content-Type |
string
|
|
True |
Returns:
Type:Find-Individual-IDOrEmailResponse
Summary: Add Individual to Committee
Description: Add Individual to Committee
Syntax:
Impexium.Add-To-Committee (string code, [internal]string Content-Type, [Optional]Add-To-CommitteeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
code |
string (Committee Code) |
Committee Code |
True |
|
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Summary: Add Organization
Description: Add Organization
Syntax:
Impexium.Add-Organization ([internal]string Content-Type, [Optional]Add-OrganizationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Type:OrganizationData
Description: OrganizationData
Summary: Add Relationship to Individual
Description: Add Relationship to Individual
Syntax:
Impexium.Add-relationship-to-individual (string id, [internal]string Content-Type, [Optional]Add-relationship-to-individualParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Individual ID) |
Individual ID |
True |
|
|
Content-Type |
string
|
|
True |
|
|
body |
Add-relationship-to-individualParameterBody
|
|
False |
Returns:
Type:Add-relationship-to-individualResponse
Summary: Update Organization
Description: Update Organization
Syntax:
Impexium.Update-Organization (string id, [internal]string Content-Type, [Optional]Update-OrganizationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Organization ID) |
Organization ID |
True |
|
|
Content-Type |
string
|
|
True |
|
|
body |
Update-OrganizationParameterBody
|
|
False |
Returns:
Type:OrganizationData
Description: OrganizationData
Summary: List of all custom fields
Description: List of all custom fields
Syntax:
Impexium.List-of-all-custom-fields ([internal]string Content-type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-type |
string
|
|
True |
Returns:
Type:List-of-all-custom-fieldsResponse
Summary: Find Customer by Phone Number
Description: Find Customer by Phone Number
Syntax:
Impexium.Find-Customer-Phone ([internal]string pageNumber, string phoneNumber, [internal]boolean includeAddress, [internal]boolean includePhone, [internal]boolean includeEmail, [internal]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
pageNumber |
string
|
|
True |
|
|
phoneNumber |
string (Phone Number) |
Phone Number |
True |
|
|
includeAddress |
boolean
|
|
True |
|
|
includePhone |
boolean
|
|
True |
|
|
includeEmail |
boolean
|
|
True |
|
|
Content-Type |
string
|
|
True |
Returns:
Type:Find-Customer-PhoneResponse
Summary: Update Custom Field Value
Description: Update Custom Field Value
Syntax:
Impexium.Update-custom-field-value (string id, [internal]string Content-Type, [Optional]Update-custom-field-valueParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Customer ID) |
Customer ID |
True |
|
|
Content-Type |
string
|
|
True |
|
|
body |
Update-custom-field-valueParameterBody
|
|
False |
Returns:
Type:Update-custom-field-valueResponse
Summary: Individual Created
Description: When an Individual is created
Syntax:
Impexium.When-Individual-Created ([internal]string Content-Type, When-Individual-CreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
body |
When-Individual-CreatedParameterBody
|
|
True |
Returns:
Type:When-Individual-CreatedResponse
Summary: When Product is Purchased
Description: When Product is Purchased. Supported Product Types: Merchandise, Courses, Exams
Syntax:
Impexium.When-product-purchased ([internal]string Content-Type, When-product-purchasedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
body |
When-product-purchasedParameterBody
|
|
True |
Returns:
Type:When-product-purchasedResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
string
|
Category |
|
text |
string
|
Text |
|
url |
string
|
url |
|
activityDate |
string
|
Activity Date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
firstName |
string
|
First Name |
|
lastName |
string
|
Last Name |
|
|
string
|
Email Address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
Name |
|
showInDirectory |
boolean
|
show In Directory Values: [, ] |
|
branchName |
string
|
Branch Name |
|
website |
string
|
Website |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
relationshipName |
string
|
relationshipName |
|
relatedToCustomerRecordNumber |
string
|
Related To Customer Record Number |
|
reciprocalRelationshipName |
string
|
reciprocalRelationshipName |
|
isPrimary |
boolean
|
isPrimary Values: [, ] |
|
startDate |
string
|
Start Date |
|
endDate |
string
|
End Date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recordNumber |
string
|
Record Number |
|
code |
string
|
Member code |
|
positionCode |
string
|
Position Code |
|
startDate |
string
|
Start Date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
MemberId |
|
firstName |
string
|
FirstName |
|
lastName |
string
|
LastName |
|
code |
string
|
Code |
|
recordNumber |
string
|
RecordNumber |
|
position |
string
|
Position |
|
positionCode |
string
|
PositionCode |
|
startDate |
string
|
StartDate |
|
endDate |
string
|
EndDate |
|
primaryOrganization |
|
|
|
organizationRepresenting |
|
|
|
nominatedByCustomer |
|
|
|
addresses |
array of (AddressesItem)
|
|
|
phones |
array of (PhonesItem)
|
|
|
emails |
array of (EmailsItem)
|
|
|
rank |
integer
|
Rank |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contactIds |
array of (string(uuid)) ContactIds |
PrimaryOrganization-ContactIds |
|
parentCompanyId |
string
|
PrimaryOrganization-ParentCompanyId |
|
description |
string
|
PrimaryOrganization-Description |
|
branchName |
string
|
PrimaryOrganization-BranchName |
|
tags |
array of (string) Tags |
PrimaryOrganization-Tags |
|
id |
string
|
PrimaryOrganization-PrimaryOrganizationId |
|
customerType |
string
|
PrimaryOrganization-CustomerType |
|
recordNumber |
string
|
PrimaryOrganization-RecordNumber |
|
title |
string
|
PrimaryOrganization-Title |
|
name |
string
|
PrimaryOrganization-Name |
|
addresses |
array of (AddressesItem)
|
|
|
|
string
|
PrimaryOrganization-Email |
|
imageUri |
string
|
PrimaryOrganization-ImageUri |
|
|
string
|
PrimaryOrganization-Twitter |
|
|
string
|
PrimaryOrganization-LinkedIn |
|
emails |
array of (EmailsItem)
|
|
|
phones |
array of (PhonesItem)
|
|
|
webSite |
string
|
PrimaryOrganization-WebSite |
|
memberships |
array of (MembershipsItem)
|
|
|
category |
string
|
PrimaryOrganization-Category |
|
categories |
array of (CategoriesItem)
|
|
|
customFields |
array of (CustomFieldsItem)
|
|
|
showInDirectory |
boolean
|
PrimaryOrganization-ShowInDirectory |
|
links |
array of (LinksItem)
|
|
|
oldId |
string
|
PrimaryOrganization-OldId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
PrimaryOrganization-Addresses-AddressId |
|
primary |
boolean
|
PrimaryOrganization-Addresses-PrimaryAddress |
|
line1 |
string
|
PrimaryOrganization-Addresses-Line1 |
|
line2 |
string
|
PrimaryOrganization-Addresses-Line2 |
|
line3 |
string
|
PrimaryOrganization-Addresses-Line3 |
|
city |
string
|
PrimaryOrganization-Addresses-City |
|
state |
string
|
PrimaryOrganization-Addresses-State |
|
zipcode |
string
|
PrimaryOrganization-Addresses-ZipCode |
|
country |
string
|
PrimaryOrganization-Addresses-Country |
|
stateAbbreviation |
string
|
PrimaryOrganization-Addresses-StateAbbreviation |
|
stateISOCode |
string
|
PrimaryOrganization-Addresses-StateISOCode |
|
type |
string
|
PrimaryOrganization-Addresses-Type |
|
region |
string
|
PrimaryOrganization-Addresses-Region |
|
latitude |
number
|
PrimaryOrganization-Addresses-Latitude |
|
longitude |
number
|
PrimaryOrganization-Addresses-Longitude |
|
showInDirectory |
boolean
|
PrimaryOrganization-Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
PrimaryOrganization-Addresses-CongressionalDistrict |
|
countryData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
PrimaryOrganization-Addresses-Country-CountryId |
|
name |
string
|
PrimaryOrganization-Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
PrimaryOrganization-Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
PrimaryOrganization-Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
PrimaryOrganization-Addresses-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
PrimaryOrganization-Emails-Primary |
|
address |
string
|
PrimaryOrganization-Emails-Address |
|
type |
string
|
PrimaryOrganization-Emails-Type |
|
showInDirectory |
boolean
|
PrimaryOrganization-Emails-ShowInDirectory |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
PrimaryOrganization-Phones-Id |
|
primary |
boolean
|
PrimaryOrganization-Phones-Primary |
|
type |
integer
|
PrimaryOrganization-Phones-Type |
|
country |
|
|
|
showInDirectory |
boolean
|
PrimaryOrganization-Phones-ShowInDirectory |
|
number |
string
|
PrimaryOrganization-Phones-Number |
|
extension |
string
|
PrimaryOrganization-Phones-Extension |
|
typeName |
string
|
PrimaryOrganization-Phones-TypeName |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
PrimaryOrganization-Phones-Country-CountryId |
|
name |
string
|
PrimaryOrganization-Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
PrimaryOrganization-Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
PrimaryOrganization-Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
PrimaryOrganization-Phones-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
PrimaryOrganization-Memberships-MembershipType |
|
membershipTypeId |
string
|
PrimaryOrganization-Memberships-MembershipTypeId |
|
code |
string
|
PrimaryOrganization-Memberships-Code |
|
expireDate |
string
|
PrimaryOrganization-Memberships-ExpireDate |
|
graceExpireDate |
string
|
PrimaryOrganization-Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
PrimaryOrganization-Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
PrimaryOrganization-Memberships-RenewalUrl |
|
joinDate |
string
|
PrimaryOrganization-Memberships-JoinDate |
|
terminateDate |
string
|
PrimaryOrganization-Memberships-TerminateDate |
|
effectiveDate |
string
|
PrimaryOrganization-Memberships-EffectiveDate |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
PrimaryOrganization-Categories-Subcategories |
|
code |
string
|
PrimaryOrganization-Categories-Code |
|
name |
string
|
PrimaryOrganization-Categories-Name |
Summary:
Description: PrimaryOrganization-Categories-Subcategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
PrimaryOrganization-Categories-SubCategories-Code |
|
name |
string
|
PrimaryOrganization-Categories-SubCategories-Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
PrimaryOrganization-CustomFields-Name |
|
caption |
string
|
PrimaryOrganization-CustomFields-Caption |
|
value |
string
|
PrimaryOrganization-CustomFields-Value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
PrimaryOrganization-Links-Type |
|
url |
string
|
PrimaryOrganization-Links-Type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contactIds |
array of (string(uuid)) ContactIds |
OrganizationRepresenting-ContactIds |
|
parentCompanyId |
string
|
OrganizationRepresenting-ParentCompanyId |
|
description |
string
|
OrganizationRepresenting-Description |
|
branchName |
string
|
OrganizationRepresenting-BranchName |
|
tags |
array of (string) Tags |
OrganizationRepresenting-Tags |
|
id |
string
|
OrganizationRepresenting-OrganizationRepresentingId |
|
customerType |
string
|
OrganizationRepresenting-CustomerType |
|
recordNumber |
string
|
OrganizationRepresenting-RecordNumber |
|
title |
string
|
OrganizationRepresenting-Title |
|
name |
string
|
OrganizationRepresenting-Name |
|
addresses |
array of (AddressesItem)
|
|
|
|
string
|
OrganizationRepresenting-Email |
|
imageUri |
string
|
OrganizationRepresenting-ImageUri |
|
|
string
|
OrganizationRepresenting-Twitter |
|
|
string
|
OrganizationRepresenting-LinkedIn |
|
emails |
array of (EmailsItem)
|
|
|
phones |
array of (PhonesItem)
|
|
|
webSite |
string
|
OrganizationRepresenting-WebSite |
|
memberships |
array of (MembershipsItem)
|
|
|
category |
string
|
OrganizationRepresenting-Category |
|
categories |
array of (CategoriesItem)
|
OrganizationRepresenting-Categories |
|
customFields |
array of (CustomFieldsItem)
|
|
|
showInDirectory |
boolean
|
OrganizationRepresenting-ShowInDirectory |
|
links |
array of (LinksItem)
|
|
|
oldId |
string
|
OrganizationRepresenting-OldId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
OrganizationRepresenting-Addresses-AddressId |
|
primary |
boolean
|
OrganizationRepresenting-Addresses-PrimaryAddress |
|
line1 |
string
|
OrganizationRepresenting-Addresses-Line1 |
|
line2 |
string
|
OrganizationRepresenting-Addresses-Line2 |
|
line3 |
string
|
OrganizationRepresenting-Addresses-Line3 |
|
city |
string
|
OrganizationRepresenting-Addresses-City |
|
state |
string
|
OrganizationRepresenting-Addresses-State |
|
zipcode |
string
|
OrganizationRepresenting-Addresses-ZipCode |
|
country |
string
|
OrganizationRepresenting-Addresses-Country |
|
stateAbbreviation |
string
|
OrganizationRepresenting-Addresses-StateAbbreviation |
|
stateISOCode |
string
|
OrganizationRepresenting-Addresses-StateISOCode |
|
type |
string
|
OrganizationRepresenting-Addresses-Type |
|
region |
string
|
OrganizationRepresenting-Addresses-Region |
|
latitude |
number
|
OrganizationRepresenting-Addresses-Latitude |
|
longitude |
number
|
OrganizationRepresenting-Addresses-Longitude |
|
showInDirectory |
boolean
|
OrganizationRepresenting-Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
OrganizationRepresenting-Addresses-CongressionalDistrict |
|
countryData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
OrganizationRepresenting-Addresses-Country-CountryId |
|
name |
string
|
OrganizationRepresenting-Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
OrganizationRepresenting-Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
OrganizationRepresenting-Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
OrganizationRepresenting-Addresses-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
OrganizationRepresenting-Emails-Primary |
|
address |
string
|
OrganizationRepresenting-Emails-Address |
|
type |
string
|
OrganizationRepresenting-Emails-Type |
|
showInDirectory |
boolean
|
OrganizationRepresenting-Emails-ShowInDirectory |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
OrganizationRepresenting-Phones-Id |
|
primary |
boolean
|
OrganizationRepresenting-Phones-Primary |
|
type |
integer
|
OrganizationRepresenting-Phones-Type |
|
country |
|
|
|
showInDirectory |
boolean
|
OrganizationRepresenting-Phones-ShowInDirectory |
|
number |
string
|
OrganizationRepresenting-Phones-Number |
|
extension |
string
|
OrganizationRepresenting-Phones-Extension |
|
typeName |
string
|
OrganizationRepresenting-Phones-TypeName |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
OrganizationRepresenting-Phones-Country-CountryId |
|
name |
string
|
OrganizationRepresenting-Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
OrganizationRepresenting-Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
OrganizationRepresenting-Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
OrganizationRepresenting-Phones-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
OrganizationRepresenting-Memberships-MembershipType |
|
membershipTypeId |
string
|
OrganizationRepresenting-Memberships-MembershipTypeId |
|
code |
string
|
OrganizationRepresenting-Memberships-Code |
|
expireDate |
string
|
OrganizationRepresenting-Memberships-ExpireDate |
|
graceExpireDate |
string
|
OrganizationRepresenting-Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
OrganizationRepresenting-Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
OrganizationRepresenting-Memberships-RenewalUrl |
|
joinDate |
string
|
OrganizationRepresenting-Memberships-JoinDate |
|
terminateDate |
string
|
OrganizationRepresenting-Memberships-TerminateDate |
|
effectiveDate |
string
|
OrganizationRepresenting-Memberships-EffectiveDate |
Summary:
Description: OrganizationRepresenting-Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
OrganizationRepresenting-Categories-Subcategories |
|
code |
string
|
OrganizationRepresenting-Categories-Code |
|
name |
string
|
OrganizationRepresenting-Categories-Name |
Summary:
Description: OrganizationRepresenting-Categories-Subcategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
OrganizationRepresenting-Categories-SubCategories-Code |
|
name |
string
|
OrganizationRepresenting-Categories-SubCategories-Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
OrganizationRepresenting-CustomFields-Name |
|
caption |
string
|
OrganizationRepresenting-CustomFields-Caption |
|
value |
string
|
OrganizationRepresenting-CustomFields-Value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
OrganizationRepresenting-Links-Type |
|
url |
string
|
OrganizationRepresenting-Links-Type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
NominatedByCustomer-NominatedByCustomerId |
|
customerType |
string
|
NominatedByCustomer-CustomerType |
|
recordNumber |
string
|
NominatedByCustomer-RecordNumber |
|
title |
string
|
NominatedByCustomer-Title |
|
name |
string
|
NominatedByCustomer-Name |
|
addresses |
array of (AddressesItem)
|
|
|
|
string
|
NominatedByCustomer-Email |
|
imageUri |
string
|
NominatedByCustomer-ImageUri |
|
|
string
|
NominatedByCustomer-Twitter |
|
|
string
|
NominatedByCustomer-LinkedIn |
|
emails |
array of (EmailsItem)
|
|
|
phones |
array of (PhonesItem)
|
|
|
webSite |
string
|
NominatedByCustomer-WebSite |
|
memberships |
array of (MembershipsItem)
|
|
|
category |
string
|
NominatedByCustomer-Category |
|
categories |
array of (CategoriesItem)
|
NominatedByCustomer-Categories |
|
customFields |
array of (CustomFieldsItem)
|
|
|
showInDirectory |
boolean
|
NominatedByCustomer-ShowInDirectory |
|
links |
array of (LinksItem)
|
|
|
oldId |
string
|
NominatedByCustomer-OldId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
NominatedByCustomer-Addresses-AddressId |
|
primary |
boolean
|
NominatedByCustomer-Addresses-PrimaryAddress |
|
line1 |
string
|
NominatedByCustomer-Addresses-Line1 |
|
line2 |
string
|
NominatedByCustomer-Addresses-Line2 |
|
line3 |
string
|
NominatedByCustomer-Addresses-Line3 |
|
city |
string
|
NominatedByCustomer-Addresses-City |
|
state |
string
|
NominatedByCustomer-Addresses-State |
|
zipcode |
string
|
NominatedByCustomer-Addresses-ZipCode |
|
country |
string
|
NominatedByCustomer-Addresses-Country |
|
stateAbbreviation |
string
|
NominatedByCustomer-Addresses-StateAbbreviation |
|
stateISOCode |
string
|
NominatedByCustomer-Addresses-StateISOCode |
|
type |
string
|
NominatedByCustomer-Addresses-Type |
|
region |
string
|
NominatedByCustomer-Addresses-Region |
|
latitude |
number
|
NominatedByCustomer-Addresses-Latitude |
|
longitude |
number
|
NominatedByCustomer-Addresses-Longitude |
|
showInDirectory |
boolean
|
NominatedByCustomer-Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
NominatedByCustomer-Addresses-CongressionalDistrict |
|
countryData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
NominatedByCustomer-Addresses-Country-CountryId |
|
name |
string
|
NominatedByCustomer-Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
NominatedByCustomer-Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
NominatedByCustomer-Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
NominatedByCustomer-Addresses-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
NominatedByCustomer-Emails-Primary |
|
address |
string
|
NominatedByCustomer-Emails-Address |
|
type |
string
|
NominatedByCustomer-Emails-Type |
|
showInDirectory |
boolean
|
NominatedByCustomer-Emails-ShowInDirectory |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
NominatedByCustomer-Phones-Id |
|
primary |
boolean
|
NominatedByCustomer-Phones-Primary |
|
type |
integer
|
NominatedByCustomer-Phones-Type |
|
country |
|
|
|
showInDirectory |
boolean
|
NominatedByCustomer-Phones-ShowInDirectory |
|
number |
string
|
NominatedByCustomer-Phones-Number |
|
extension |
string
|
NominatedByCustomer-Phones-Extension |
|
typeName |
string
|
NominatedByCustomer-Phones-TypeName |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
NominatedByCustomer-Phones-Country-CountryId |
|
name |
string
|
NominatedByCustomer-Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
NominatedByCustomer-Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
NominatedByCustomer-Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
NominatedByCustomer-Phones-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
NominatedByCustomer-Memberships-MembershipType |
|
membershipTypeId |
string
|
NominatedByCustomer-Memberships-MembershipTypeId |
|
code |
string
|
NominatedByCustomer-Memberships-Code |
|
expireDate |
string
|
NominatedByCustomer-Memberships-ExpireDate |
|
graceExpireDate |
string
|
NominatedByCustomer-Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
NominatedByCustomer-Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
NominatedByCustomer-Memberships-RenewalUrl |
|
joinDate |
string
|
NominatedByCustomer-Memberships-JoinDate |
|
terminateDate |
string
|
NominatedByCustomer-Memberships-TerminateDate |
|
effectiveDate |
string
|
NominatedByCustomer-Memberships-EffectiveDate |
Summary:
Description: NominatedByCustomer-Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
NominatedByCustomer-Categories-SubCategories |
|
code |
string
|
NominatedByCustomer-Categories-Code |
|
name |
string
|
NominatedByCustomer-Categories-Name |
Summary:
Description: NominatedByCustomer-Categories-SubCategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
NominatedByCustomer-Categories-SubCategories-Code |
|
name |
string
|
NominatedByCustomer-Categories-SubCategories-Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
NominatedByCustomer-CustomFields-Name |
|
caption |
string
|
NominatedByCustomer-CustomFields-Caption |
|
value |
string
|
NominatedByCustomer-CustomFields-Value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
NominatedByCustomer-Links-Type |
|
url |
string
|
NominatedByCustomer-Links-Type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Addresses-AddressId |
|
primary |
boolean
|
Addresses-PrimaryAddress |
|
line1 |
string
|
Addresses-Line1 |
|
line2 |
string
|
Addresses-Line2 |
|
line3 |
string
|
Addresses-Line3 |
|
city |
string
|
Addresses-City |
|
state |
string
|
Addresses-State |
|
zipcode |
string
|
Addresses-ZipCode |
|
country |
string
|
Addresses-Country |
|
stateAbbreviation |
string
|
Addresses-StateAbbreviation |
|
stateISOCode |
string
|
Addresses-StateISOCode |
|
type |
string
|
Addresses-Type |
|
region |
string
|
Addresses-Region |
|
latitude |
number
|
Addresses-Latitude |
|
longitude |
number
|
Addresses-Longitude |
|
showInDirectory |
boolean
|
Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
Addresses-CongressionalDistrict |
|
countryData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Addresses-Country-CountryId |
|
name |
string
|
Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
Addresses-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Id |
|
primary |
boolean
|
Phones-Primary |
|
type |
integer
|
Phones-Type |
|
country |
|
|
|
showInDirectory |
boolean
|
Phones-ShowInDirectory |
|
number |
string
|
Phones-Number |
|
extension |
string
|
Phones-Extension |
|
typeName |
string
|
Phones-TypeName |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Country-CountryId |
|
name |
string
|
Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
Phones-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
Emails-Primary |
|
address |
string
|
Emails-Address |
|
type |
string
|
Emails-Type |
|
showInDirectory |
boolean
|
Emails-ShowInDirectory |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pageNumber |
integer
|
PageNumber |
|
dataList |
array of (DataListItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fullName |
string
|
FullName |
|
id |
string
|
CustomerId |
|
customerType |
string
|
CustomerType |
|
recordNumber |
string
|
RecordNumber |
|
showInDirectory |
boolean
|
ShowInDirectory |
|
addresses |
array of (AddressesItem)
|
|
|
emails |
array of (EmailsItem)
|
|
|
phones |
array of (PhonesItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
AddressesAddressId |
|
primary |
boolean
|
Addresses-PrimaryAddress |
|
line1 |
string
|
Addresses-Line1 |
|
line2 |
string
|
Addresses-Line2 |
|
line3 |
string
|
Addresses-Line3 |
|
city |
string
|
Addresses-City |
|
state |
string
|
Addresses-State |
|
zipcode |
string
|
Addresses-ZipCode |
|
country |
string
|
Addresses-Country |
|
stateAbbreviation |
string
|
Addresses-StateAbbreviation |
|
stateISOCode |
string
|
Addresses-StateISOCode |
|
type |
string
|
Addresses-Type |
|
region |
string
|
Addresses-Region |
|
latitude |
number
|
Addresses-Latitude |
|
longitude |
number
|
Addresses-Longitude |
|
showInDirectory |
boolean
|
Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
Addresses-CongressionalDistrict |
|
countryData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Addresses-Country-CountryId |
|
name |
string
|
Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
Addresses-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
Emails-Primary |
|
address |
string
|
Emails-Address |
|
type |
string
|
Emails-Type |
|
showInDirectory |
boolean
|
Emails-ShowInDirectory |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Id |
|
primary |
boolean
|
Phones-Primary |
|
type |
integer
|
Phones-Type |
|
country |
|
|
|
showInDirectory |
boolean
|
Phones-ShowInDirectory |
|
number |
string
|
Phones-Number |
|
extension |
string
|
Phones-Extension |
|
typeName |
string
|
Phones-TypeName |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Country-CountryId |
|
name |
string
|
Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
Phones-Country-CountryCode |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pageNumber |
integer(int32)
|
Page Number |
|
dataList |
array of (IndividualData)
|
Data List |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
firstName |
string
|
FirstName |
|
lastName |
string
|
LastName |
|
middleName |
string
|
MiddleName |
|
preferredFirstName |
string
|
PreferredFirstName |
|
secondLastName |
string
|
SecondLastName |
|
prefix |
string
|
Prefix |
|
suffix |
string
|
Suffix |
|
gender |
string
|
Gender |
|
primaryOrganization |
|
|
|
committees |
array of (CommitteesItem)
|
Committees |
|
securityRoles |
array of (SecurityRolesItem)
|
SecurityRoles |
|
user |
|
|
|
designationData |
array of (DesignationDataItem)
|
Designations |
|
relationships |
array of (RelationshipsItem)
|
Relationships |
|
jobRoles |
array of (JobRolesItem)
|
JobRoles |
|
tags |
array of (string)
|
Tags |
|
id |
string(uuid)
|
IndividualId |
|
customerType |
string
|
CustomerType |
|
recordNumber |
string
|
RecordNumber |
|
title |
string
|
Title |
|
name |
string
|
Name |
|
addresses |
array of (AddressesItem)
|
Addresses |
|
|
string(email)
|
|
|
imageUri |
string(uri)
|
ImageUri |
|
|
string(uri)
|
|
|
|
string(uri)
|
|
|
emails |
array of (EmailsItem)
|
Emails |
|
phones |
array of (PhonesItem)
|
Phones |
|
webSite |
string(uri)
|
WebSite |
|
memberships |
array of (MembershipsItem)
|
Memberships |
|
category |
string
|
Category |
|
categories |
array of (CategoriesItem)
|
Categories |
|
customFields |
array of (CustomFieldsItem)
|
CustomFields |
|
showInDirectory |
boolean
|
ShowInDirectory |
|
links |
array of (LinksItem)
|
Links |
|
oldId |
string
|
OldId |
|
isDeceased |
boolean
|
IsDeceased |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contactIds |
array of (string(uuid)) ContactIds |
PrimaryOrganization-ContactIds |
|
parentCompanyId |
string(uuid)
|
PrimaryOrganization-ParentCompanyId |
|
description |
string
|
PrimaryOrganization-Description |
|
branchName |
string
|
PrimaryOrganization-BranchName |
|
tags |
array of (string) Tags |
PrimaryOrganization-Tags |
|
id |
string(uuid)
|
PrimaryOrganizationId |
|
customerType |
string
|
PrimaryOrganization-CustomerType |
|
recordNumber |
string
|
PrimaryOrganization-RecordNumber |
|
title |
string
|
PrimaryOrganization-Title |
|
name |
string
|
PrimaryOrganization-Name |
|
addresses |
array of (AddressesItem)
|
PrimaryOrganization-Addresses |
|
|
string(email)
|
PrimaryOrganization-Email |
|
imageUri |
string(uri)
|
PrimaryOrganization-ImageUri |
|
|
string(uri)
|
PrimaryOrganization-Twitter |
|
|
string(uri)
|
PrimaryOrganization-LinkedIn |
|
emails |
array of (EmailsItem)
|
PrimaryOrganization-Emails |
|
phones |
array of (PhonesItem)
|
PrimaryOrganization-Phones |
|
webSite |
string(uri)
|
PrimaryOrganization-WebSite |
|
memberships |
array of (MembershipsItem)
|
PrimaryOrganization-Memberships |
|
category |
string
|
PrimaryOrganization-Category |
|
categories |
array of (CategoriesItem)
|
PrimaryOrganization-Categories |
|
customFields |
array of (CustomFieldsItem)
|
PrimaryOrganization-CustomFields |
|
showInDirectory |
boolean
|
PrimaryOrganization-ShowInDirectory |
|
links |
array of (LinksItem)
|
PrimaryOrganization-Links |
|
oldId |
string
|
PrimaryOrganization-OldId |
Summary:
Description: PrimaryOrganization-Addresses-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
PrimaryOrganization-Addresses-Id |
|
primary |
boolean
|
PrimaryOrganization-Addresses-IsPrimary |
|
line1 |
string
|
PrimaryOrganization-Addresses-Line1 |
|
line2 |
string
|
PrimaryOrganization-Addresses-Line2 |
|
line3 |
string
|
PrimaryOrganization-Addresses-Line3 |
|
city |
string
|
PrimaryOrganization-Addresses-City |
|
state |
string
|
PrimaryOrganization-Addresses-State |
|
zipcode |
string
|
PrimaryOrganization-Addresses-ZipCode |
|
country |
string
|
PrimaryOrganization-Addresses-Country |
|
stateAbbreviation |
string
|
PrimaryOrganization-Addresses-StateAbbreviation |
|
stateISOCode |
string
|
PrimaryOrganization-Addresses-StateISOCode |
|
type |
string
|
PrimaryOrganization-Addresses-Type |
|
region |
string
|
PrimaryOrganization-Addresses-Region |
|
latitude |
number
|
PrimaryOrganization-Addresses-Latitude |
|
longitude |
number
|
PrimaryOrganization-Addresses-Longitude |
|
showInDirectory |
boolean
|
PrimaryOrganization-Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
PrimaryOrganization-Addresses-CongressionalDistrict |
|
countryData |
|
PrimaryOrganization-Addresses-Country |
Summary:
Description: PrimaryOrganization-Addresses-Country
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
PrimaryOrganization-Addresses-Country-Id |
|
name |
string
|
PrimaryOrganization-Addresses-Country-Name |
|
twoLetterIsoCode |
string
|
PrimaryOrganization-Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
PrimaryOrganization-Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
PrimaryOrganization-Addresses-Country-Code |
Summary:
Description: PrimaryOrganization-Emails-Item
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
PrimaryOrganization-Emails-IsPrimary |
|
address |
string
|
PrimaryOrganization-Emails-Address |
|
type |
string
|
PrimaryOrganization-Emails-Type |
|
showInDirectory |
boolean
|
PrimaryOrganization-Emails-ShowInDirectory |
Summary:
Description: PrimaryOrganization-Phones-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
PrimaryOrganization-Phones-Id |
|
primary |
boolean
|
PrimaryOrganization-Phones-IsPrimary |
|
type |
integer
|
PrimaryOrganization-Phones-Type |
|
country |
|
PrimaryOrganization-Phones-Country |
|
showInDirectory |
boolean
|
PrimaryOrganization-Phones-ShowInDirectory |
|
number |
string
|
PrimaryOrganization-Phones-Number |
|
extension |
string
|
PrimaryOrganization-Phones-Extension |
|
typeName |
string
|
PrimaryOrganization-Phones-TypeName |
Summary:
Description: PrimaryOrganization-Phones-Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
PrimaryOrganization-Phones-Country-Id |
|
name |
string
|
PrimaryOrganization-Phones-Country-Name |
|
twoLetterIsoCode |
string
|
PrimaryOrganization-Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
PrimaryOrganization-Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
PrimaryOrganization-Phones-Country-Code |
Summary:
Description: PrimaryOrganization-Memberships-Item
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
PrimaryOrganization-Memberships-MembershipType |
|
membershipTypeId |
string(uuid)
|
PrimaryOrganization-Memberships-MembershipTypeId |
|
code |
string
|
PrimaryOrganization-Memberships-Code |
|
expireDate |
string(date-time)
|
PrimaryOrganization-Memberships-ExpireDate |
|
graceExpireDate |
string(date-time)
|
PrimaryOrganization-Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
PrimaryOrganization-Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
PrimaryOrganization-Memberships-RenewalUrl |
|
joinDate |
string(date-time)
|
PrimaryOrganization-Memberships-JoinDate |
|
terminateDate |
string(date-time)
|
PrimaryOrganization-Memberships-TerminateDate |
|
effectiveDate |
string(date-time)
|
PrimaryOrganization-Memberships-EffectiveDate |
Summary:
Description: PrimaryOrganization-Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
PrimaryOrganization-Categories-Subcategories |
|
code |
string
|
PrimaryOrganization-Categories-Code |
|
name |
string
|
PrimaryOrganization-Categories-Name |
Summary:
Description: PrimaryOrganization-Categories-Subcategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
PrimaryOrganization-Categories-SubCategories-Code |
|
name |
string
|
PrimaryOrganization-Categories-SubCategories-Name |
Summary:
Description: PrimaryOrganization-CustomFields-Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
PrimaryOrganization-CustomFields-Name |
|
caption |
string
|
PrimaryOrganization-CustomFields-Caption |
|
value |
string
|
PrimaryOrganization-CustomFields-Value |
Summary:
Description: PrimaryOrganization-Links-Item
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
PrimaryOrganization-Links-Type |
|
url |
string(uri)
|
PrimaryOrganization-Links-Url |
Summary:
Description: Committees-Item
Properties:
|
Name |
Type |
Summary |
|
committee |
|
Committees-Committee |
|
position |
string
|
Committees-Position |
|
positionCode |
string
|
Committees-PositionCode |
|
code |
string
|
Committees-Code |
|
startDate |
string(date-time)
|
Committees-StartDate |
|
endDate |
string(date-time)
|
Committees-EndDate |
Summary:
Description: Committees-Committee
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Committees-Committee-Name |
|
code |
string
|
Committees-Committee-Code |
|
website |
string
|
Committees-Committee-Website |
|
id |
string(uuid)
|
Committees-Committee-Id |
|
parentCommitteeId |
string(uuid)
|
Committees-Committee-ParentCommitteeId |
|
categoryName |
string
|
Committees-Committee-CategoryName |
|
categoryCode |
string
|
Committees-Committee-CategoryCode |
|
description |
string
|
Committees-Committee-Description |
|
startDate |
string(date-time)
|
Committees-Committee-StartDate |
|
endDate |
string(date-time)
|
Committees-Committee-EndDate |
|
showInDirectory |
boolean
|
Committees-Committee-ShowInDirectory |
|
term |
|
Committees-Committee-Term |
|
tags |
array of (string)
|
Committees-Committee-Tags |
Summary:
Description: Committees-Committee-Term
Properties:
|
Name |
Type |
Summary |
|
term |
integer
|
Committees-Committee-Term-Term |
|
startDate |
string(date-time)
|
Committees-Committee-Term-StartDate |
|
endDate |
string(date-time)
|
Committees-Committee-Term-EndDate |
|
showInDirectory |
boolean
|
Committees-Committee-Term-ShowInDirectory |
Summary:
Description: SecurityRoles-Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
SecurityRoles-Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
loginEmail |
string
|
User-LoginEmail |
|
mustChangePassword |
boolean
|
User-MustChangePassword |
|
isApproved |
boolean
|
User-IsApproved |
Summary:
Description: Designations Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Designations-Name |
Summary:
Description: Relationships Item
Properties:
|
Name |
Type |
Summary |
|
relationshipName |
string
|
Relationships-RelationshipName |
|
relatedToCustomer |
|
RelatedToCustomer |
|
reciprocalRelationshipName |
string
|
Relationships-ReciprocalRelationshipName |
|
isPrimary |
boolean
|
Relationships-IsPrimary |
|
startDate |
string(date-time)
|
Relationships-StartDate |
|
endDate |
string(date-time)
|
Relationships-EndDate |
Summary:
Description: RelatedToCustomer
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Relationships-RelatedToCustomer-Id |
|
customerType |
string
|
Relationships-RelatedToCustomer-CustomerType |
|
recordNumber |
string
|
Relationships-RelatedToCustomer-RecordNumber |
|
title |
string
|
Relationships-RelatedToCustomer-Title |
|
name |
string
|
Relationships-RelatedToCustomer-Name |
|
addresses |
array of (AddressesItem)
|
Relationships-RelatedToCustomer-Addresses |
|
|
string(email)
|
Relationships-RelatedToCustomer-Email |
|
imageUri |
string(uri)
|
Relationships-RelatedToCustomer-ImageUri |
|
|
string(uri)
|
Relationships-RelatedToCustomer-Twitter |
|
|
string(uri)
|
Relationships-RelatedToCustomer-LinkedIn |
|
emails |
array of (EmailsItem)
|
Relationships-RelatedToCustomer-Emails |
|
phones |
array of (PhonesItem)
|
Relationships-RelatedToCustomer-Phones |
|
webSite |
string
|
Relationships-RelatedToCustomer-WebSite |
|
memberships |
array of (MembershipsItem)
|
Relationships-RelatedToCustomer-Memberships |
|
category |
string
|
Relationships-RelatedToCustomer-Category |
|
categories |
array of (CategoriesItem)
|
Relationships-RelatedToCustomer-Categories |
|
customFields |
array of (CustomFieldsItem)
|
Relationships-RelatedToCustomer-CustomFields |
|
showInDirectory |
boolean
|
Relationships-RelatedToCustomer-ShowInDirectory |
|
links |
array of (LinksItem)
|
Relationships-RelatedToCustomer-Links |
|
oldId |
string
|
Relationships-RelatedToCustomer-OldId |
Summary:
Description: Relationships-RelatedToCustomer-Addresses-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Relationships-RelatedToCustomer-Addresses-Id |
|
primary |
boolean
|
Relationships-RelatedToCustomer-Addresses-IsPrimary |
|
line1 |
string
|
Relationships-RelatedToCustomer-Addresses-Line1 |
|
line2 |
string
|
Relationships-RelatedToCustomer-Addresses-Line2 |
|
line3 |
string
|
Relationships-RelatedToCustomer-Addresses-Line3 |
|
city |
string
|
Relationships-RelatedToCustomer-Addresses-City |
|
state |
string
|
Relationships-RelatedToCustomer-Addresses-State |
|
zipcode |
string
|
Relationships-RelatedToCustomer-Addresses-ZipCode |
|
country |
string
|
Relationships-RelatedToCustomer-Addresses-Country |
|
stateAbbreviation |
string
|
Relationships-RelatedToCustomer-Addresses-StateAbbreviation |
|
stateISOCode |
string
|
Relationships-RelatedToCustomer-Addresses-StateISOCode |
|
type |
string
|
Relationships-RelatedToCustomer-Addresses-Type |
|
region |
string
|
Relationships-RelatedToCustomer-Addresses-Region |
|
latitude |
number
|
Relationships-RelatedToCustomer-Addresses-Latitude |
|
longitude |
number
|
Relationships-RelatedToCustomer-Addresses-Longitude |
|
showInDirectory |
boolean
|
Relationships-RelatedToCustomer-Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
Relationships-RelatedToCustomer-Addresses-CongressionalDistrict |
|
countryData |
|
Country |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Relationships-RelatedToCustomer-Addresses-Country-Id |
|
name |
string
|
Relationships-RelatedToCustomer-Addresses-Country-Name |
|
twoLetterIsoCode |
string
|
Relationships-RelatedToCustomer-Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Relationships-RelatedToCustomer-Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
Relationships-RelatedToCustomer-Addresses-Country-Code |
Summary:
Description: Relationships-RelatedToCustomer-Emails-Item
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
Relationships-RelatedToCustomer-Emails-IsPrimary |
|
address |
string
|
Relationships-RelatedToCustomer-Emails-Address |
|
type |
string
|
Relationships-RelatedToCustomer-Emails-Type |
|
showInDirectory |
boolean
|
Relationships-RelatedToCustomer-Emails-ShowInDirectory |
Summary:
Description: Relationships-RelatedToCustomer-Phones-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Relationships-RelatedToCustomer-Phones-Id |
|
primary |
boolean
|
Relationships-RelatedToCustomer-Phones-IsPrimary |
|
type |
integer
|
Relationships-RelatedToCustomer-Phones-Type |
|
country |
|
Country |
|
showInDirectory |
boolean
|
Relationships-RelatedToCustomer-Phones-ShowInDirectory |
|
number |
string
|
Relationships-RelatedToCustomer-Phones-Number |
|
extension |
string
|
Relationships-RelatedToCustomer-Phones-Extension |
|
typeName |
string
|
Relationships-RelatedToCustomer-Phones-TypeName |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Relationships-RelatedToCustomer-Phones-Country-Id |
|
name |
string
|
Relationships-RelatedToCustomer-Phones-Country-Name |
|
twoLetterIsoCode |
string
|
Relationships-RelatedToCustomer-Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Relationships-RelatedToCustomer-Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
Relationships-RelatedToCustomer-Phones-Country-Code |
Summary:
Description: Relationships-RelatedToCustomer-Memberships-Item
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
Relationships-RelatedToCustomer-Memberships-MembershipType |
|
membershipTypeId |
string
|
Relationships-RelatedToCustomer-Memberships-MembershipTypeId |
|
code |
string
|
Relationships-RelatedToCustomer-Memberships-Code |
|
expireDate |
string(date-time)
|
Relationships-RelatedToCustomer-Memberships-ExpireDate |
|
graceExpireDate |
string(date-time)
|
Relationships-RelatedToCustomer-Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
Relationships-RelatedToCustomer-Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
Relationships-RelatedToCustomer-Memberships-RenewalUrl |
|
joinDate |
string(date-time)
|
Relationships-RelatedToCustomer-Memberships-JoinDate |
|
terminateDate |
string(date-time)
|
Relationships-RelatedToCustomer-Memberships-TerminateDate |
|
effectiveDate |
string(date-time)
|
Relationships-RelatedToCustomer-Memberships-EffectiveDate |
Summary:
Description: Relationships-RelatedToCustomer-Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
Relationships-RelatedToCustomer-Categories-SubCategories |
|
code |
string
|
Relationships-RelatedToCustomer-Categories-Code |
|
name |
string
|
Relationships-RelatedToCustomer-Categories-Name |
Summary:
Description: Relationships-RelatedToCustomer-Categories-SubCategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
Relationships-RelatedToCustomer-Categories-SubCategories-Code |
|
name |
string
|
Relationships-RelatedToCustomer-Categories-SubCategories-Name |
Summary:
Description: Relationships-RelatedToCustomer-CustomFields-Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Relationships-RelatedToCustomer-CustomFields-Name |
|
caption |
string
|
Relationships-RelatedToCustomer-CustomFields-Caption |
|
value |
string
|
Relationships-RelatedToCustomer-CustomFields-Value |
Summary:
Description: Relationships-RelatedToCustomer-Links-Item
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
Relationships-RelatedToCustomer-Links-Type |
|
url |
string
|
Relationships-RelatedToCustomer-Links-Url |
Summary:
Description: JobRoles-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
JobRoles-Code |
|
name |
string
|
JobRoles-name |
Summary:
Description: Addresses-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Addresses-Id |
|
primary |
boolean
|
Addresses-IsPrimary |
|
line1 |
string
|
Addresses-Line1 |
|
line2 |
string
|
Addresses-Line2 |
|
line3 |
string
|
Addresses-Line3 |
|
city |
string
|
Addresses-City |
|
state |
string
|
Addresses-State |
|
zipcode |
string
|
Addresses-ZipCode |
|
country |
string
|
Addresses-Country |
|
stateAbbreviation |
string
|
Addresses-StateAbbreviation |
|
stateISOCode |
string
|
Addresses-StateISOCode |
|
type |
string
|
Addresses-Type |
|
region |
string
|
Addresses-Region |
|
latitude |
number
|
Addresses-Latitude |
|
longitude |
number
|
Addresses-Longitude |
|
showInDirectory |
boolean
|
Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
Addresses-CongressionalDistrict |
|
countryData |
|
Country |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Addresses-Country-Id |
|
name |
string
|
Addresses-Country-Name |
|
twoLetterIsoCode |
string
|
Addresses-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Addresses-Country-ThreeLetterIsoCode |
|
code |
integer
|
Addresses-Country-Code |
Summary:
Description: Emails-Item
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
Emails-IsPrimary |
|
address |
string
|
Emails-Address |
|
type |
string
|
Emails-Type |
|
showInDirectory |
boolean
|
Emails-ShowInDirectory |
Summary:
Description: Phones-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Id |
|
primary |
boolean
|
Phones-IsPrimary |
|
type |
integer
|
Phones-Type |
|
country |
|
Country |
|
showInDirectory |
boolean
|
Phones-ShowInDirectory |
|
number |
string
|
Phones-Number |
|
extension |
string
|
Phones-Extension |
|
typeName |
string
|
Phones-TypeName |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Phones-Country-Id |
|
name |
string
|
Phones-Country-Name |
|
twoLetterIsoCode |
string
|
Phones-Country-TwoLetterIsoCode |
|
threeLetterIsoCode |
string
|
Phones-Country-ThreeLetterIsoCode |
|
code |
integer
|
Phones-Country-Code |
Summary:
Description: Memberships-Item
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
Memberships-MembershipType |
|
membershipTypeId |
string
|
Memberships-MembershipTypeId |
|
code |
string
|
Memberships-Code |
|
expireDate |
string(date-time)
|
Memberships-ExpireDate |
|
graceExpireDate |
string(date-time)
|
Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string
|
Memberships-RenewalUrl |
|
joinDate |
string(date-time)
|
Memberships-JoinDate |
|
terminateDate |
string(date-time)
|
Memberships-TerminateDate |
|
effectiveDate |
string(date-time)
|
Memberships-EffectiveDate |
Summary:
Description: Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
Categories-Subcategories |
|
code |
string
|
Categories-Code |
|
name |
string
|
Categories-Name |
Summary:
Description: Categories-Subcategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
Categories-SubCategories-Code |
|
name |
string
|
Categories-SubCategories-Name |
Summary:
Description: CustomFields-Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
CustomFields-Name |
|
caption |
string
|
CustomFields-Caption |
|
value |
string
|
CustomFields-Value |
Summary:
Description: Links Item
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
Links-Type |
|
url |
string
|
Links-Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pageNumber |
integer(int32)
|
pageNumber |
|
dataList |
array of (DataListItem)
|
dataList |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
caption |
string
|
caption |
|
description |
string
|
description |
|
dataType |
string
|
dataType |
|
inputType |
string
|
inputType |
|
availableValues |
array of (AvailableValuesItem)
|
availableValues |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: OrganizationData
Properties:
|
Name |
Type |
Summary |
|
pageNumber |
integer(int32)
|
PageNumber |
|
dataList |
array of (DataListItem)
|
DataList |
Summary:
Description: DataList-Item
Properties:
|
Name |
Type |
Summary |
|
contactIds |
array of (string)
|
ContactIds |
|
parentCompanyId |
string(uuid)
|
ParentCompanyId |
|
description |
string
|
Description |
|
branchName |
string
|
BranchName |
|
tags |
array of (string)
|
Tags |
|
id |
string(uuid)
|
OrganizationId |
|
customerType |
string
|
CustomerType |
|
recordNumber |
string
|
RecordNumber |
|
title |
string
|
Title |
|
name |
string
|
OrganizationName |
|
addresses |
array of (AddressesItem)
|
Addresses |
|
|
string(email)
|
|
|
imageUri |
string(uri)
|
ImageUri |
|
|
string(uri)
|
|
|
|
string(uri)
|
|
|
emails |
array of (EmailsItem)
|
Emails |
|
phones |
array of (PhonesItem)
|
Phones |
|
webSite |
string(uri)
|
WebSite |
|
memberships |
array of (MembershipsItem)
|
Memberships |
|
category |
string
|
Category |
|
categories |
array of (CategoriesItem)
|
Categories |
|
customFields |
array of (CustomFieldsItem)
|
CustomFields |
|
showInDirectory |
boolean
|
ShowInDirectory |
|
links |
array of (LinksItem)
|
Links |
|
oldId |
string
|
OldId |
Summary:
Description: Addresses-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Addresses-AddressId |
|
primary |
boolean
|
Addresses-IsPrimary |
|
line1 |
string
|
Addresses-Line1 |
|
line2 |
string
|
Addresses-Line2 |
|
line3 |
string
|
Addresses-Line3 |
|
city |
string
|
Addresses-City |
|
state |
string
|
Addresses-State |
|
zipcode |
string
|
Addresses-ZipCode |
|
country |
string
|
Addresses-Country |
|
stateAbbreviation |
string
|
Addresses-StateAbbreviation |
|
stateISOCode |
string
|
Addresses-StateISOCode |
|
type |
string
|
Addresses-Type |
|
region |
string
|
Addresses-Region |
|
latitude |
string
|
Addresses-Latitude |
|
longitude |
string
|
Addresses-Longitude |
|
showInDirectory |
boolean
|
Addresses-ShowInDirectory |
|
congressionalDistrict |
string
|
Addresses-CongressionalDistrict |
|
countryData |
|
Country |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Addresses-Country-CountryId |
|
name |
string
|
Addresses-Country-CountryName |
|
twoLetterIsoCode |
string
|
Addresses-Country-TwoLetterISOCode |
|
threeLetterIsoCode |
string
|
Addresses-Country-ThreeLetterISOCode |
|
code |
string
|
Addresses-Country-CountryCode |
Summary:
Description: Emails-Item
Properties:
|
Name |
Type |
Summary |
|
primary |
boolean
|
Emails-IsPrimary |
|
address |
string(email)
|
Emails-EmailAddress |
|
type |
string
|
Emails-Type |
|
showInDirectory |
boolean
|
Emails-ShowInDirectory |
Summary:
Description: Phones-Item
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Phones-PhoneId |
|
primary |
boolean
|
Phones-IsPrimary |
|
type |
string
|
Phones-Type |
|
country |
|
Country |
|
showInDirectory |
boolean
|
Phones-ShowInDirectory |
|
number |
string
|
Phones-PhoneNumber |
|
extension |
string
|
Phones-Extension |
|
typeName |
string
|
Phones-TypeName |
Summary:
Description: Country
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Phones-Country-CountryId |
|
name |
string
|
Phones-Country-CountryName |
|
twoLetterIsoCode |
string
|
Phones-Country-TwoLetterISOCode |
|
threeLetterIsoCode |
string
|
Phones-Country-ThreeLetterISOCode |
|
code |
string
|
Phones-Country-CountryCode |
Summary:
Description: Memberships-Item
Properties:
|
Name |
Type |
Summary |
|
membershipType |
string
|
Memberships-MembershipType |
|
membershipTypeId |
string(uuid)
|
Memberships-MembershipTypeId |
|
code |
string
|
Memberships-MembershipTypeCode |
|
expireDate |
string(date-time)
|
Memberships-ExpireDate |
|
graceExpireDate |
string(date-time)
|
Memberships-GraceExpireDate |
|
inheritedMembershipBenefits |
boolean
|
Memberships-InheritedMembershipBenefits |
|
renewalUrl |
string(uri)
|
Memberships-RenewalUrl |
|
joinDate |
string(date-time)
|
Memberships-JoinDate |
|
terminateDate |
string(date-time)
|
Memberships-TerminateDate |
|
effectiveDate |
string(date-time)
|
Memberships-EffectiveDate |
Summary:
Description: Categories-Item
Properties:
|
Name |
Type |
Summary |
|
subCategories |
array of (SubCategoriesItem)
|
Categories-Subcategories |
|
code |
string
|
Categories-CategoryCode |
|
name |
string
|
Categories-CategoryName |
Summary:
Description: Categories-Subcategories-Item
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
Categories-Subcategories-SubcategoryCode |
|
name |
string
|
Categories-Subcategories-SubcategoryName |
Summary:
Description: CustomFields-Item
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
CustomFields-Name |
|
caption |
string
|
CustomFields-Caption |
|
value |
string
|
CustomFields-Value |
Summary:
Description: Links-Item
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
Links-Type |
|
url |
string(uri)
|
Links-Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Custom Field Name |
|
value |
string
|
Custom Field Value. For multi-selects, use "|" as delimiter |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name |
|
description |
string
|
Description |
|
showInDirectory |
boolean
|
Show In Directory Values: [, ] |
|
branchName |
string
|
Branch Name |
|
website |
string
|
Website |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
typeName |
string
|
typeName |
|
filters |
array of (string)
|
filters |
|
secret |
string
|
secret |
|
callBackUrl |
string
|
callBackUrl |
|
description |
string
|
description |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
typeName |
string
|
typeName |
|
filters |
array of (string)
|
filters |
|
secret |
string
|
secret |
|
callBackUrl |
string
|
callBackUrl |
|
description |
string
|
description |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |