Contact Activities API Reference
undefined
API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
Returns a list of contacts based on query.
Returns a list of contacts in a pagable group. Takes in full Odata object. Example Request: api/contacts?skip=0&take=1&orderBy=ContactId
(no description)
OK
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
Returns contacts with advanced filtering.
Returns a list of contacts according to the specified filtering options.
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactType": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"StatusTypeOptions": "string",
"Criteria": "string",
"EmailContains": "string",
"PhoneContains": "string",
"WebsiteContains": "string",
"TitleContains": "string",
"AccountNumber": "string",
"NameOrAccountNumber": "string",
"City": "string",
"Country": "string",
"StateProvinceLookup": "string",
"AssignedToId": "string",
"GroupId": "string",
"CategoryItemId": "string",
"Tags": "string",
"ContactId": "string",
"TasksAssignedTo": "string",
"IsStaff": "boolean",
"HasBalance": "boolean",
"HasDueOverdueTasks": "boolean",
"ContactNotInCRM": "boolean",
"IsContact": "integer",
"ModifiedSinceUtc": "string",
"TenantCountry": "integer",
"ShowContactCountryInAddress": "boolean",
"TenantOrganizationId": "integer",
"PotentialAttendeesContact": "boolean",
"AbandonedMembershipContact": "boolean"
}
A model object that contains the list of contacts that matched the filtering criteria of the operation.
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/contacts/{contactid}/customfield/{customfieldid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"SelectListData": "string",
"CustomFieldDataTypeId": "string",
"SelectListDataArray": "string",
"ContactId": "string",
"Key": "integer",
"Id": "integer",
"CustomFieldId": "integer",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldType": "string",
"StandardFieldId": "string",
"DataSize": "string",
"FieldGroupName": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsRequiredOriginal": "boolean",
"IsArchived": "boolean",
"ScriptVariableName": "string",
"DisplayOrder": "string",
"GroupDisplayOrder": "string",
"ValueId": "integer",
"ValueAuditId": "integer",
"ObjectTypeId": "string",
"ClientParsers": "string",
"DbParsers": "string",
"ParsedValue": "string",
"Value": "string",
"IsDeleted": "boolean",
"TableColumns": "string",
"TotalTableColumns": "integer",
"ScaleModel": "string",
"ExternalDataSource": "string",
"SelectOptions": "string",
"FileModel": "string",
"Icon": "string",
"IsFormResponseValue": "boolean"
}
GET /api/contacts/{contactid}/editcontactaddlinfo/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"EstablishedDate": "string",
"Bio": "string"
}
GET /api/contacts/{contactid}/editcontactorginfo
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"EstablishedDate": "string",
"Naics": "string",
"Sic": "string"
}
GET /api/contacts/{contactid}/editnotes
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"Notes": "string"
}
GET /api/contacts/{contactid}/engagement
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"HideDownload": "boolean",
"SystemContactTypeId": "string",
"DisplayName": "string",
"RangeStartDate": "string",
"RangeEndDate": "string",
"FromDateMessage": "string",
"AuditId": "integer",
"OptionalIntroText": "string",
"MembershipInfo": "string",
"MembershipMsg": "string",
"Benefits": "string",
"BenefitMsg": "string",
"DirectoryInfo": "string",
"DirectoryMsg": "string",
"MemberActivityWidgetData": "string",
"ResourceAccessInfoWidgetData": "string",
"LastLogin": "string",
"ResourceAccessCount": "integer",
"ContactName": "string",
"WebMetricsWidgetData": "string",
"PageViewsCount": "integer",
"LinkExternalSiteCounts": "integer",
"LastLoginTime": "string",
"Balance": "number",
"GroupCount": "integer",
"CommunicationWidgetData": "string",
"EventRegMonthWidgetData": "string",
"EventRegYearWidgetData": "string",
"EventRegCount": "integer",
"EventSponsorCount": "integer",
"EventExhibitorCount": "integer",
"AdsCount": "integer",
"DealsCount": "integer",
"JobsCount": "integer",
"EventsCount": "integer",
"ContEdCompletedCount": "integer",
"ContEdInProgressCount": "integer",
"Notes": "string",
"WidgetData": "string",
"GroupNames": "string",
"EventsRegNames": "string",
"EventsSponsoredNames": "string",
"EventsExhibitedNames": "string",
"EventsSubmittedNames": "string",
"AdNames": "string",
"DealsNames": "string",
"JobsNames": "string",
"IsMetricModuleEnabled": "boolean"
}
GET /api/contacts/{contactid}/individual/access/{contactroleid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ContactRoleId": "integer",
"RoleTypeId": "string",
"IsDisabled": "boolean",
"MemberRoleId": "string",
"LoginId": "string",
"Username": "string",
"LoginUsername": "string",
"PasswordResetEmail": "string",
"DefaultEmailMessage": "string",
"SendLoginInstructionsEmail": "boolean",
"SendPasswordResetEmail": "boolean",
"TemporaryPassword": "string",
"Password": "string",
"AccessLevelsAccessLevelWithOrgs": "string",
"IsSAMLEnabled": "boolean",
"CssClass": "string",
"IsDeletable": "boolean",
"BlockPasswordChange": "boolean",
"AuditInfo": "string"
}
GET /api/contacts/{contactid}/moreinfo
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"SearchObjectTypeId": "string",
"ObjectTypeId": "string",
"AuditId": "integer",
"Fields": "string",
"Notes": "string",
"OrgInfo": "string",
"AddlInfo": "string",
"HasAccessToSetup": "boolean"
}
Returns custom fields for contact
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"AuditId": "integer",
"Notes": "string",
"Bio": "string",
"EstablishedDate": "string",
"Naics": "string",
"Sic": "string",
"Fields": "string",
"HasAccessToSetup": "boolean"
}
GET /api/contacts/{contactid}/organization/access
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"OrganizationDataAccess": "string"
}
GET /api/contacts/{contactid}/organizations/typeahead
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
]
POST /api/contacts/{contactid}/representatives
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ColumnsToShow": "string",
"ModelColumns": "string",
"TenantId": "integer",
"ContactId": "integer",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/contacts/{contactid}/staff/access/{contactroleid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ContactRoleId": "integer",
"RoleTypeId": "string",
"MemberRoleId": "string",
"LoginId": "string",
"Username": "string",
"SendLoginInstructionsEmail": "boolean",
"SendPasswordResetEmail": "boolean",
"PasswordResetEmail": "string",
"DefaultEmailMessage": "string",
"AccessLevelsAccessLevelWithOrgs": "string",
"AuditInfo": "string"
}
GET /api/contacts/{contactid}/videos/{videoid}/edit
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"VideoId": "integer",
"Url": "string",
"Name": "string",
"Description": "string",
"VideoTypeId": "string",
"EmbedCode": "string"
}
GET /api/contacts/{purchaseid}/lookup/{billingcontactid}/{systemcontacttypeid}/all/emailaddresses/{billingemailid}
(no description)
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"EmailAddress": "string",
"EmailAddressId": "integer"
}
]
GET /api/contacts/accessedresourcelist/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"Items": "string",
"ShowContactNameColumn": "boolean"
}
GET /api/contacts/address/{contactid}/{contactaddressid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactAddressId": "integer",
"AddressId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryId": "string",
"AddressTypeId": "string",
"AddressUsageFlagId": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"AddressAuditId": "integer",
"BillingContactId": "integer"
}
GET /api/contacts/address/city/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/address/stateprovince/lookup/{country}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/address/tenant/countries/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/billingaddress/{billingcontactid}
(no description)
OK
Response Example (200 OK)
{
"ContactAddressId": "integer",
"AddressId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryId": "string",
"AddressTypeId": "string",
"AddressUsageFlagId": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"AddressAuditId": "integer",
"BillingContactId": "integer"
}
GET /api/contacts/billingcontact/{contactid}/contact/{systemcontacttypeid}/{primarycontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"PrimaryContactId": "string",
"forceSave": "boolean",
"IndividualContactId": "integer",
"ProjectId": "integer",
"RoleRequired": "boolean",
"FirstName": "string",
"LastName": "string",
"CommonName": "string",
"MarkAsPrimary": "boolean",
"RoleId": "string",
"Title": "string",
"DisplayOnWeb": "boolean",
"RoleStartDate": "string",
"RoleEndDate": "string",
"ContactList": "string",
"Addresses": "string",
"SystemContactTypeId": "string"
}
GET /api/contacts/billingemail/{billingcontactid}
(no description)
OK
Response Example (200 OK)
{
"ContactEmailAddressId": "integer",
"ContactId": "integer",
"EmailAddressId": "integer",
"WarningIcon": "string",
"Warning": "string",
"UpdateAllInstances": "boolean",
"EmailValidityStatusId": "string",
"EmailAddress": "string",
"EmailAddressType": "string",
"AssistantAddress": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"RestrictionStatus": "string",
"AuditId": "integer",
"EmailAddressAuditId": "integer",
"DoNotContact": "boolean",
"DoNotSendMassEmail": "boolean",
"RestrictionStatusValue": "string",
"BillingContactId": "integer"
}
GET /api/contacts/bulk
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/contacts/contact/{contactid}/{systemcontacttypeid}/billingindividuals
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"EmailAddress": "string",
"Address1": "string",
"City": "string",
"StateProvince": "string",
"AddressString": "string",
"AddressId": "integer",
"EmailAddressId": "integer"
}
]
GET /api/contacts/contact/{contactid}/{systemcontacttypeid}/people/{billingcontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"EmailAddress": "string",
"Address1": "string",
"City": "string",
"StateProvince": "string",
"AddressString": "string",
"AddressId": "integer",
"EmailAddressId": "integer"
}
]
GET /api/contacts/contact/{contactid}/billing/contacts
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/{contactid}/organization
(no description)
OK
GET /api/contacts/contact/{contactid}/people/{billingcontactid}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/{contactid}/peoplewithorg/{billingcontactid}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/{contactid}/peoplewithorg/{billingcontactid}/{primarycontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/blank/{systemcontacttypeid}/{contactid}
(no description)
(no description)
OK
POST /api/contacts/contact/duplicatecheck/{systemcontacttypeid}
undefined
(no description)
Request Example
{
"FirstName": "string",
"LastName": "string",
"ContactList": "string",
"ContactsOnly": "boolean",
"ContactId": "string",
"Name": "string"
}
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
]
GET /api/contacts/contact/incrm/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/contact/info/blank/{contactid}
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"ContactId": "integer",
"ContactDisplayName": "string",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string"
}
GET /api/contacts/contact/lognoterecipients/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"Id": "integer",
"IsSelected": "boolean",
"PreviouslySelected": "boolean"
}
]
GET /api/contacts/contact/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/contact/lookup/iscontact
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/contact/lookup/referred
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/contact/membershipowner/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/contact/primarycontacts/eventexhibitor/{eventexhibitorid}/{primarycontactid}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/recipient/lookup/{contactid}/{organizationid}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contact/sponsor/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"SponsorContactId": "integer",
"PrimaryContactId": "integer",
"Name": "string",
"AdditionalData": "string"
}
]
Get all activities for given Contact
Get all activities for given Contact
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
Search for activities by given Contact and advanced search criteria
Search for activities by given Contact and advanced search criteria
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactId": "integer",
"ByContactId": "integer",
"ActivityTypeId": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/contacts/contactactivity/create
undefined
Request Example
{
"ObjectId": "integer",
"OverrideObjectIdWithUniqueValue": "boolean",
"IsDeleted": "boolean",
"Description": "string",
"ContactId": "integer",
"ActivityDate": "string",
"ActivityType": "string"
}
OK
Response Example (200 OK)
{
"ErrorMessages": "string"
}
Look up a list of addresses associated with contact
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/contactemails/{contactid}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"EmailAddressTypeId": "string"
}
]
GET /api/contacts/contactengagementcommunication/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactengagementeventregmonth/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactengagementeventregyear/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactengagementmemberlogin/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactengagementresourceaccessinfo/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactengagementwebmetric/{contactid}/{systemcontacttypeid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"series": "string",
"data": "string",
"extraStats": "string"
}
GET /api/contacts/contactorganization/lookup
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/contacts/{contactexperienceitemid}/{contactid}/{experienceitemtypeid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactExperienceItemId": "integer",
"ContactId": "integer",
"AuditId": "integer",
"ExperienceItemTypeId": "string",
"Education": "string",
"Work": "string",
"Volunteer": "string",
"License": "string"
}
GET /api/contacts/contacts/experience/degreetypes
OK
Response Example (200 OK)
[
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contacts/publishedby/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"PublishedByContactId": "string",
"DisplayName": "string",
"Name": "string",
"ContactDisplayName": "string"
}
]
GET /api/contacts/contacts/purchasecontact/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string",
"IsTaxExempt": "boolean",
"TaxRegionId": "string",
"ContactTaxSetRate": "number",
"ContactTaxSetFloatAmount": "number",
"AccountNumber": "string"
}
]
GET /api/contacts/contacts/to/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ToContactId": "string",
"DisplayName": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string"
}
]
GET /api/contacts/contacts/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
]
GET /api/contacts/contacts/typeahead/{contactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"SponsorContactId": "integer",
"PrimaryContactId": "integer",
"Name": "string",
"AdditionalData": "string"
}
]
GET /api/contacts/contacttype
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/contactwithorg/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"ContactName": "string",
"Name": "string",
"OrgName": "string",
"OrganizationContactId": "string",
"Title": "string"
}
]
GET /api/contacts/contactwithorg/sponsor/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"SponsorContactId": "integer",
"PrimaryContactId": "integer",
"Name": "string",
"ContactName": "string",
"AdditionalData": "string",
"OrgName": "string",
"OrganizationContactId": "string",
"Title": "string"
}
]
Returns list of contacts changed since specified date
Returns a list of contacts modified since the supplied modified datetime. Returned ordered by the date and time modified. All date filters are based on UTC time Example Requests. Year Month Day: /api/contacts/delta?top=100&modifiedSince=2022-01-01 With Time: /api/contacts/delta?top=100&modifiedSince=2022-01-01T12:00:00
(no description)
(no description)
The number of changed contacts to returned
OK
GET /api/contacts/designations/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/donorcontact/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/email/{contactemailaddressid}
(no description)
OK
Response Example (200 OK)
{
"ContactEmailAddressId": "integer",
"ContactId": "integer",
"EmailAddressId": "integer",
"WarningIcon": "string",
"Warning": "string",
"UpdateAllInstances": "boolean",
"EmailValidityStatusId": "string",
"EmailAddress": "string",
"EmailAddressType": "string",
"AssistantAddress": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"RestrictionStatus": "string",
"AuditId": "integer",
"EmailAddressAuditId": "integer",
"DoNotContact": "boolean",
"DoNotSendMassEmail": "boolean",
"RestrictionStatusValue": "string",
"BillingContactId": "integer"
}
GET /api/contacts/email/{contactemailaddressid}/{contactid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactEmailAddressId": "integer",
"ContactId": "integer",
"EmailAddressId": "integer",
"WarningIcon": "string",
"Warning": "string",
"UpdateAllInstances": "boolean",
"EmailValidityStatusId": "string",
"EmailAddress": "string",
"EmailAddressType": "string",
"AssistantAddress": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"RestrictionStatus": "string",
"AuditId": "integer",
"EmailAddressAuditId": "integer",
"DoNotContact": "boolean",
"DoNotSendMassEmail": "boolean",
"RestrictionStatusValue": "string",
"BillingContactId": "integer"
}
GET /api/contacts/email/typeahead/{search}
(no description)
OK
Response Example (200 OK)
[
{
"EmailAddress": "string",
"EmailAddressId": "integer",
"ContactName": "string",
"ContactId": "string",
"FirstName": "string",
"LastName": "string",
"Name": "string"
}
]
GET /api/contacts/email/typeahead/person/{search}
(no description)
OK
Response Example (200 OK)
[
{
"EmailAddress": "string",
"EmailAddressId": "integer",
"ContactName": "string",
"ContactId": "string",
"FirstName": "string",
"LastName": "string",
"Name": "string"
}
]
GET /api/contacts/email/validityactions/{emailaddressid}/{contactemailaddressid}/{purchaseid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
{
"PurchaseId": "string",
"ContactEmailAddressId": "string",
"EmailAddressId": "integer",
"EmailAddress": "string",
"Status": "string",
"EmailValiditySourceTypeId": "string",
"ReportedBy": "string",
"LastStatusUpdate": "string",
"BannerMessage": "string",
"WarningMessage": "string",
"Actions": "string",
"NewEmailAddress": "string"
}
GET /api/contacts/engagement/download/{contactid}
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/contacts/experience/all/{contactid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
POST /api/contacts/export/activity/{contactid}
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactId": "integer",
"ByContactId": "integer",
"ActivityTypeId": "string",
"Criteria": "string"
}
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/contacts/family/{contactid}/add
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string"
}
GET /api/contacts/family/{contactid}/edit
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string",
"FamilyName": "string"
}
GET /api/contacts/family/blank/{contactid}
(no description)
OK
POST /api/contacts/family/duplicatecheck
undefined
Request Example
{
"ContactId": "string",
"Name": "string"
}
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
]
GET /api/contacts/family/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"ContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string"
}
]
GET /api/contacts/family/typeahead/{sourcecontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"ContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string"
}
]
GET /api/contacts/genders/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/getcontactentities/{contactid}/{tenantkey}
(no description)
(no description)
OK
Response Example (200 OK)
{
"AccountNumber": "string",
"ContactId": "integer",
"AuditId": "integer",
"TenantId": "integer",
"IsDeleted": "boolean",
"IsContact": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"DisplayName": "string",
"Suffix": "string",
"CommonName": "string",
"Name": "string",
"PrimaryTitle": "string",
"PrimaryEmailAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryWebAddressId": "string",
"PrimaryAddressId": "string",
"PrimaryContactId": "string",
"SystemContactTypeId": "string",
"MembershipIds": "string",
"ContactIdsWithThisContactAsPrimary": "string",
"ContactPhones": "string",
"ContactWebAdress": "string",
"ContactEmailAddresses": "string",
"ContactAddresses": "string",
"ContactRoles": "string",
"OrganizationRoles": "string",
"CustomFields": "string",
"PrimaryContact": "string"
}
GET /api/contacts/groups/{contactid}/
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"Items": "string"
}
GET /api/contacts/import/{since}
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"UniqueId": "string",
"ModifiedDate": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"Gender": "string",
"Birthday": "string",
"CompanyName": "string",
"Department": "string",
"JobTitle": "string",
"BusinessAddress": "string",
"HomeAddress": "string",
"MailingAddress": "string",
"OtherAddress": "string",
"Email1Address": "string",
"Email2Address": "string",
"Email3Address": "string",
"AssistantTelephoneNumber": "string",
"BusinessTelephoneNumber": "string",
"Business2TelephoneNumber": "string",
"CallbackTelephoneNumber": "string",
"CarTelephoneNumber": "string",
"CompanyMainTelephoneNumber": "string",
"HomeTelephoneNumber": "string",
"Home2TelephoneNumber": "string",
"HomeFaxNumber": "string",
"MobileTelephoneNumber": "string",
"PrimaryTelephoneNumber": "string"
}
]
GET /api/contacts/import/wizard
OK
Response Example (200 OK)
{
"ImportContactTypeChoiceStep": "string",
"SelectOptionalColumnsStep": "string",
"ImportContactsStep": "string",
"ImportContactConfirmationStep": "string"
}
POST /api/contacts/import/wizard
undefined
Request Example
{
"ImportContactTypeChoiceStep": "string",
"SelectOptionalColumnsStep": "string",
"ImportContactsStep": "string",
"ImportContactConfirmationStep": "string"
}
OK
GET /api/contacts/individualrelationship/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/individualrelationship/lookup/{contactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"RelationshipContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/individuals/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
]
GET /api/contacts/individuals/typeahead/all
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
]
GET /api/contacts/lookup/{contactid}/contactphone
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/lookup/{contactid}/contactphonefaxes
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
Returns websites tied to contact from contact info.
Returns website names and ids tied to contact id.
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/lookup/{contactid}/licenses
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/merge/{sourcecontactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SourceContactId": "integer",
"IsStaff": "boolean",
"forceSave": "boolean",
"DestinationContactId": "integer",
"DestinationContactName": "string",
"TaxSet": "string",
"Logo": "string",
"Notes": "string",
"ShortDescription": "string",
"Description": "string",
"Keywords": "string",
"Highlights": "string",
"ContactName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"Title": "string",
"EstablishedDate": "string",
"CustomFields": "string",
"RealtorCustomFields": "string",
"BrokerReciprocity": "string",
"SyncWithNRDS": "string",
"SyncWithLockbox": "string",
"SyncWithMLS": "string",
"NRDSStatus": "string",
"NRDSMemberId": "string",
"NRDSOfficeId": "string",
"NRDSJoinDate": "string",
"MemberMLSAssociationId": "string",
"MemberOccupationName": "string",
"OfficeNMSalesCount": "string",
"PrimaryState": "string",
"StopMail": "string",
"StopFax": "string",
"StopJunkMail": "string",
"RealtorOfficeType": "string",
"OfficeFormalName": "string",
"MLSOfficeId": "string",
"MLSId": "string",
"MLSJoinDate": "string",
"MLSOfficeLicenseNumber": "string",
"MLSTermDate": "string",
"MLSStatus": "string",
"LockBoxStatusOptions": "string",
"NRDSPrimaryFieldOfBusiness": "string",
"LicensingState": "string",
"NrdsAgentType": "string",
"DuesWaivedLocal": "string",
"DuesWaivedState": "string",
"DuesWaivedNAR": "string",
"AgentType": "string",
"EthicsTrainingDate": "string",
"EducationCourseCode": "string",
"EducationCourseNumber": "string",
"COEYear": "string",
"LocalDesignations": "string",
"IsSupplementalRecord": "string",
"NRDSTimestamp": "string",
"NRDSPreferredFaxType": "string",
"NRDSPreferredPhoneType": "string",
"AffiliationId": "string",
"AssistantContactRelationshipTypeId": "string",
"CMLSMember": "string",
"IDPPassword": "string",
"LocalJoinDate": "string",
"LockBoxAgentId": "string",
"LockboxCardStatus": "string",
"LockBoxExternalId": "string",
"LockBoxListingAgent": "string",
"LockboxMemberType": "string",
"LockBoxOfficeId": "string",
"LockBoxPass": "string",
"LockBoxUserName": "string",
"MemberBirthDate": "string",
"MemberClass": "string",
"MemberOrientationDate": "string",
"MemberSalutation": "string",
"MemberSubclass": "string",
"MLSAccessLevel": "string",
"MLSIDXOfficeParticipation": "string",
"MLSLoginId": "string",
"MLSParticipant": "string",
"MLSWaived": "string",
"NRDSAddlContactPhoneId": "string",
"NRDSCellContactPhoneId": "string",
"NRDSContactEmailAddressId": "string",
"NRDSPersonalEmailId": "string",
"NRDSSharedEmailId": "string",
"NRDSTeamEmailId": "string",
"NRDSContactPhoneId": "string",
"NRDSFaxContactPhoneId": "string",
"NRDSLicenseNumber": "string",
"NRDSMailingContactAddressId": "string",
"NRDSPersonWebAddressId": "string",
"NRDSPhysicalContactAddressId": "string",
"NRDSPreferredMailType": "string",
"NRDSPreferredPublicationType": "string",
"OfficeBrokerMLSId": "string",
"OfficeContactDRId": "string",
"OfficeManagerNRDSId": "string",
"PMArbitrationEthicsPending": "string",
"PMAssociationID": "string",
"PMAssociationPOEID": "string",
"PMBillingDiscount": "string",
"PMMLSID": "string",
"PMMLSOnlineStatus": "string",
"PMMLSOnlineStatusChangedDate": "string",
"PMNationalDuesPaidDate": "string",
"PMOnRosterFlag": "string",
"PMPreviousNonMemberFlag": "string",
"PMReinstatementCode": "string",
"PMReinstatementDate": "string",
"PMStateDuesPaidDate": "string",
"PMStatusChangedDate": "string",
"POAssociationID": "string",
"POAssociationPOEID": "string",
"POBillingID": "string",
"POBranchType": "string",
"POContactUnlicensed": "string",
"POCorporateLicense": "string",
"POCorporateName": "string",
"PODistrict": "string",
"POFranchiseID": "string",
"POMainID": "string",
"POMLSID": "string",
"POMLSOnlineStatus": "string",
"POMLSOnlineStatusChangedDate": "string",
"POOnRoster": "string",
"POParentCompanyID": "string",
"POStatusChangedDate": "string",
"POTaxID": "string",
"POTimestamp": "string",
"Remarks": "string",
"SOAssociationId": "string",
"SONMSalespersons": "string",
"SOOfficeNRDSID": "string",
"SOStatus": "string",
"SOStatusChangedDate": "string",
"SOSyncWithNRDS": "string",
"SOTimestamp": "string",
"StopEmail": "string",
"PostActions": "string"
}
POST /api/contacts/merge/suggest/{sourcecontactid}/{destinationcontactid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SourceContactId": "integer",
"IsStaff": "boolean",
"forceSave": "boolean",
"DestinationContactId": "integer",
"DestinationContactName": "string",
"TaxSet": "string",
"Logo": "string",
"Notes": "string",
"ShortDescription": "string",
"Description": "string",
"Keywords": "string",
"Highlights": "string",
"ContactName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"Title": "string",
"EstablishedDate": "string",
"CustomFields": "string",
"RealtorCustomFields": "string",
"BrokerReciprocity": "string",
"SyncWithNRDS": "string",
"SyncWithLockbox": "string",
"SyncWithMLS": "string",
"NRDSStatus": "string",
"NRDSMemberId": "string",
"NRDSOfficeId": "string",
"NRDSJoinDate": "string",
"MemberMLSAssociationId": "string",
"MemberOccupationName": "string",
"OfficeNMSalesCount": "string",
"PrimaryState": "string",
"StopMail": "string",
"StopFax": "string",
"StopJunkMail": "string",
"RealtorOfficeType": "string",
"OfficeFormalName": "string",
"MLSOfficeId": "string",
"MLSId": "string",
"MLSJoinDate": "string",
"MLSOfficeLicenseNumber": "string",
"MLSTermDate": "string",
"MLSStatus": "string",
"LockBoxStatusOptions": "string",
"NRDSPrimaryFieldOfBusiness": "string",
"LicensingState": "string",
"NrdsAgentType": "string",
"DuesWaivedLocal": "string",
"DuesWaivedState": "string",
"DuesWaivedNAR": "string",
"AgentType": "string",
"EthicsTrainingDate": "string",
"EducationCourseCode": "string",
"EducationCourseNumber": "string",
"COEYear": "string",
"LocalDesignations": "string",
"IsSupplementalRecord": "string",
"NRDSTimestamp": "string",
"NRDSPreferredFaxType": "string",
"NRDSPreferredPhoneType": "string",
"AffiliationId": "string",
"AssistantContactRelationshipTypeId": "string",
"CMLSMember": "string",
"IDPPassword": "string",
"LocalJoinDate": "string",
"LockBoxAgentId": "string",
"LockboxCardStatus": "string",
"LockBoxExternalId": "string",
"LockBoxListingAgent": "string",
"LockboxMemberType": "string",
"LockBoxOfficeId": "string",
"LockBoxPass": "string",
"LockBoxUserName": "string",
"MemberBirthDate": "string",
"MemberClass": "string",
"MemberOrientationDate": "string",
"MemberSalutation": "string",
"MemberSubclass": "string",
"MLSAccessLevel": "string",
"MLSIDXOfficeParticipation": "string",
"MLSLoginId": "string",
"MLSParticipant": "string",
"MLSWaived": "string",
"NRDSAddlContactPhoneId": "string",
"NRDSCellContactPhoneId": "string",
"NRDSContactEmailAddressId": "string",
"NRDSPersonalEmailId": "string",
"NRDSSharedEmailId": "string",
"NRDSTeamEmailId": "string",
"NRDSContactPhoneId": "string",
"NRDSFaxContactPhoneId": "string",
"NRDSLicenseNumber": "string",
"NRDSMailingContactAddressId": "string",
"NRDSPersonWebAddressId": "string",
"NRDSPhysicalContactAddressId": "string",
"NRDSPreferredMailType": "string",
"NRDSPreferredPublicationType": "string",
"OfficeBrokerMLSId": "string",
"OfficeContactDRId": "string",
"OfficeManagerNRDSId": "string",
"PMArbitrationEthicsPending": "string",
"PMAssociationID": "string",
"PMAssociationPOEID": "string",
"PMBillingDiscount": "string",
"PMMLSID": "string",
"PMMLSOnlineStatus": "string",
"PMMLSOnlineStatusChangedDate": "string",
"PMNationalDuesPaidDate": "string",
"PMOnRosterFlag": "string",
"PMPreviousNonMemberFlag": "string",
"PMReinstatementCode": "string",
"PMReinstatementDate": "string",
"PMStateDuesPaidDate": "string",
"PMStatusChangedDate": "string",
"POAssociationID": "string",
"POAssociationPOEID": "string",
"POBillingID": "string",
"POBranchType": "string",
"POContactUnlicensed": "string",
"POCorporateLicense": "string",
"POCorporateName": "string",
"PODistrict": "string",
"POFranchiseID": "string",
"POMainID": "string",
"POMLSID": "string",
"POMLSOnlineStatus": "string",
"POMLSOnlineStatusChangedDate": "string",
"POOnRoster": "string",
"POParentCompanyID": "string",
"POStatusChangedDate": "string",
"POTaxID": "string",
"POTimestamp": "string",
"Remarks": "string",
"SOAssociationId": "string",
"SONMSalespersons": "string",
"SOOfficeNRDSID": "string",
"SOStatus": "string",
"SOStatusChangedDate": "string",
"SOSyncWithNRDS": "string",
"SOTimestamp": "string",
"StopEmail": "string",
"PostActions": "string"
}
Returns a list of groups and their status for a given organizations contact id
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ContactDisplayName": "string",
"Groups": "string",
"GroupMembers": "string"
}
Returns memberships related to organizations
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
[
{
"MembershipId": "integer",
"MembershipActivationId": "integer",
"HashedMembershipId": "string",
"MembershipContactId": "integer",
"AuditId": "integer",
"OwnerContactId": "integer",
"MembershipContactContactId": "integer",
"Name": "string",
"Notes": "string",
"MembershipStatusTypeId": "string",
"SummaryDescription": "string",
"StartDate": "string",
"ExpirationDate": "string",
"GracePeriodExpirationDate": "string",
"EndDate": "string",
"Renewal": "string",
"InActive": "boolean",
"Actions": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"RenewalDate": "string",
"PurchaseId": "string",
"InvoiceNumber": "string",
"Balance": "string",
"MembershipPurchaseTypeId": "string",
"IsAlreadyRenewed": "boolean",
"IsRenewalPaid": "boolean",
"IsInactive": "boolean",
"IsInGracePeriod": "boolean",
"IsInGracePeriodInvoiced": "boolean",
"IsRenewDeclined": "boolean",
"DropReasonId": "string",
"CssClass": "string",
"PrimaryEmailAddressId": "string",
"MembershipTypeId": "integer",
"MembershipLevelId": "string",
"PlanOrFrequencyId": "string",
"HasPaymentPlan": "boolean",
"HasEligiblePaymentPlan": "boolean"
}
]
GET /api/contacts/organization/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string",
"ContactListHash": "string",
"AddressesHash": "string",
"PeopleHash": "string",
"OrgName": "string"
}
Returns values for populating category dropdown.
This endpoint is used to return the status of selected categories for a specific contact. While contactId is always required, the other two fields can be used in any combination. The following would all be valid requests: api/contacts/organization/0/categorychoices/null/null api/contacts/organization/0/categorychoices/1/1 api/contacts/organization/0/categorychoices/null/1 api/contacts/organization/0/categorychoices/1/null
The ID of the contact to return the fields from.
Optional parameter for filtering category type to return. Use null for no value.
Optional parameter for limiting to a specific category entry. Use null for no value.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"CategoryListId": "integer",
"CategoryTypeId": "string",
"Categories": "string",
"CategoryListName": "string",
"DisAllowPrint": "boolean"
}
GET /api/contacts/organization/{contactid}/contact/{individualcontactid}/{projectid}
(no description)
(no description)
(no description)
OK
GET /api/contacts/organization/assignedcontact/{contactrelationshipid}
(no description)
OK
Response Example (200 OK)
{
"ContactRelationshipId": "integer",
"ContactId": "integer",
"StaffContactId": "integer",
"OrganizationId": "integer",
"AuditId": "integer",
"ContactDisplayName": "string",
"RelationshipContactId": "integer",
"ContactRelationshipTypeId": "string"
}
GET /api/contacts/organization/blank/{contactid}
(no description)
OK
GET /api/contacts/organization/contacts/edit/{contactroleid}
(no description)
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"IsIndividual": "boolean",
"IsOrg": "boolean",
"IsFamily": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"Name": "string",
"DisplayName": "string",
"GenderId": "string",
"AuditId": "integer",
"ContactRoleId": "integer",
"IsAlreadyPrimaryContact": "boolean",
"OriginalStartDate": "string",
"OriginalEndDate": "string",
"OriginalTitle": "string",
"RoleTypeId": "string",
"RoleId": "string",
"Title": "string",
"UpdatedRoleId": "string",
"StartDate": "string",
"EndDate": "string",
"IsActiveOriginal": "boolean",
"IsActive": "boolean",
"DisplayOnWeb": "boolean",
"MarkAsPrimary": "boolean",
"SetAsMembershipPrimaryContact": "boolean",
"OrganizationHasActiveMembership": "boolean",
"OrganizationMembershipName": "string",
"OrganizationId": "string",
"OrganizationName": "string",
"IsBillingOrPrimaryContact": "boolean",
"SwappedContactId": "string",
"CurrentDate": "string"
}
GET /api/contacts/organization/contacts/history/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"History": "string"
}
POST /api/contacts/organization/duplicatecheck
undefined
Request Example
{
"ContactId": "string",
"Name": "string"
}
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
]
GET /api/contacts/organization/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string",
"City": "string",
"StateProvince": "string",
"EmailAddress": "string"
}
]
GET /api/contacts/organizationrelationship/lookup/{contactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"RelationshipContactId": "integer",
"Name": "string",
"City": "string",
"StateProvince": "string",
"EmailAddress": "string"
}
]
GET /api/contacts/organizations/typeahead/
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
]
GET /api/contacts/organizations/typeahead/merge/{sourcecontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
]
GET /api/contacts/organizationsummary/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"UIVersion": "string",
"SourceContactId": "integer",
"SystemContactTypeId": "string",
"CommContactRelatedOrganizationId": "string",
"CategoryTypeId": "string",
"AccountNumber": "string",
"Name": "string",
"LoginId": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"Designations": "string",
"DesignationFormatted": "string",
"CommonName": "string",
"Title": "string",
"PrimaryOrg": "string",
"IsContact": "boolean",
"DisplayName": "string",
"ContactDisplayName": "string",
"ImageDefaultObjectTypeId": "integer",
"ProfileImage": "string",
"AllowStatusEdit": "boolean",
"PrimaryEmailAddress": "string",
"PrimaryEmailAddressId": "string",
"HideFinanceEmailStatement": "boolean",
"Actions": "string",
"SettingActions": "string",
"Balance": "number",
"OpenTaskCount": "integer",
"EmailRelayServiceAddress": "string",
"Status": "string",
"AuditId": "integer",
"DoNotShowEditName": "boolean",
"CanBeDeleted": "boolean",
"HideMergeOrganization": "boolean",
"HideMergeFamily": "boolean",
"HideUserLogin": "boolean",
"HideStaffLogin": "boolean",
"HideOrganizationLogin": "boolean",
"Edition": "string",
"Tags": "string",
"IsStaff": "boolean",
"RemoveExtraMessage": "string"
}
Returns summary of one contact, and related records
The return object returns a summary of the contact id specified. The response will include Memberships, Conftact info, Related contacts, and Related Organizations
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"PersonContactId": "integer",
"ContactOrganizationId": "integer",
"SystemContactTypeId": "string",
"CategoryTypeId": "string",
"PrimaryAddressId": "string",
"PrimaryWebAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryEmailAddressId": "string",
"ContactDisplayName": "string",
"FamilyContactsEnabled": "boolean",
"RoleRequired": "boolean",
"IsDeleted": "boolean",
"ContactInfos": "string",
"Contacts": "string",
"Organizations": "string",
"Groups": "string",
"Activities": "string",
"Categories": "string",
"AssignedContacts": "string",
"Projects": "string",
"FormsResponses": "string",
"Certifications": "string",
"ShouldTrackCertificateCompletion": "boolean",
"Memberships": "string",
"SoftwareAccounts": "string",
"ContactChapters": "string",
"IsContactChaptersReadOnly": "boolean",
"RelatedIndividuals": "string",
"ContactExperiences": "string",
"ChildOrganizations": "string",
"ParentOrganizations": "string",
"RelatedOrganizations": "string",
"Communication": "string",
"SalesOpportunities": "string",
"Families": "string",
"FundraisingActivities": "string",
"AllowStatusEdit": "boolean"
}
GET /api/contacts/parentindividualrelationship/lookup/{relationshipcontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
GET /api/contacts/parentorganizationrelationship/lookup/{relationshipcontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string",
"City": "string",
"StateProvince": "string",
"EmailAddress": "string"
}
]
GET /api/contacts/people
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
Returns expanded individual info based on contact id
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"IsRealEstateEdition": "boolean",
"SystemContactTypeId": "string",
"PrimaryAddressId": "string",
"PrimaryEmailAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryWebAddressId": "string",
"PrimaryContactId": "string",
"forceSave": "boolean",
"NRDSIsStateAssociation": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"GenderId": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"DesignationMsg": "string",
"ContactDesignations": "string",
"ContactList": "string",
"Addresses": "string",
"OrganizationsAndRoles": "string"
}
GET /api/contacts/person/{contactid}/benefits
(no description)
OK
Response Example (200 OK)
{
"ScreenActions": "string",
"ListViewItems": "string"
}
GET /api/contacts/person/{contactid}/categorychoices
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ContactDisplayName": "string",
"CategoryTypeId": "string",
"Categories": "string"
}
Returns selected categories for contact
The ID of the contact to return the fields from.
Response Example (200 OK)
[
{
"CategoryListId": "integer",
"CategoryTypeId": "integer",
"IsMemberEditable": "boolean",
"CategoryItemId": "integer",
"CategoryListName": "string",
"Name": "string",
"DisplayOrder": "string",
"Actions": "string"
}
]
GET /api/contacts/person/{contactid}/groups/
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"ContactDisplayName": "string",
"Groups": "string",
"GroupMembers": "string"
}
GET /api/contacts/person/{contactid}/groupsummary/
(no description)
OK
Response Example (200 OK)
[
{
"GroupId": "integer",
"Name": "string",
"JoinDate": "string",
"HideRemoveAction": "boolean",
"IsPublicViewable": "boolean",
"Actions": "string",
"ContactId": "integer",
"Role": "string",
"DoNotContact": "boolean",
"DoNotContactText": "string",
"ContactGroupId": "integer",
"EmailAddressId": "string"
}
]
Returns memberships related to individual
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
[
{
"MembershipId": "integer",
"MembershipActivationId": "integer",
"HashedMembershipId": "string",
"MembershipContactId": "integer",
"AuditId": "integer",
"OwnerContactId": "integer",
"MembershipContactContactId": "integer",
"Name": "string",
"Notes": "string",
"MembershipStatusTypeId": "string",
"SummaryDescription": "string",
"StartDate": "string",
"ExpirationDate": "string",
"GracePeriodExpirationDate": "string",
"EndDate": "string",
"Renewal": "string",
"InActive": "boolean",
"Actions": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"RenewalDate": "string",
"PurchaseId": "string",
"InvoiceNumber": "string",
"Balance": "string",
"MembershipPurchaseTypeId": "string",
"IsAlreadyRenewed": "boolean",
"IsRenewalPaid": "boolean",
"IsInactive": "boolean",
"IsInGracePeriod": "boolean",
"IsInGracePeriodInvoiced": "boolean",
"IsRenewDeclined": "boolean",
"DropReasonId": "string",
"CssClass": "string",
"PrimaryEmailAddressId": "string",
"MembershipTypeId": "integer",
"MembershipLevelId": "string",
"PlanOrFrequencyId": "string",
"HasPaymentPlan": "boolean",
"HasEligiblePaymentPlan": "boolean"
}
]
GET /api/contacts/person/{contactid}/organizationrelationships
(no description)
OK
Response Example (200 OK)
[
{
"ContactRelationshipId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"ChildContactId": "integer",
"ParentContactId": "integer",
"OrgName": "string",
"RelatedOrgName": "string",
"City": "string",
"Type": "string",
"Actions": "string"
}
]
GET /api/contacts/person/{contactid}/organizations/{organizationcontactid}
(no description)
(no description)
OK
GET /api/contacts/person/{contactid}/salesopportunities
(no description)
OK
Response Example (200 OK)
[
{
"SalesOpportunityId": "integer",
"ContactId": "integer",
"SalesOpportunityStatus": "string",
"SalesContactName": "string",
"OneTimeValue": "string",
"RecurringValue": "string",
"EstimatedCloseDate": "string"
}
]
GET /api/contacts/person/{personcontactid}/organizations/{organizationcontactid}/aassociations
(no description)
(no description)
OK
Response Example (200 OK)
{
"OrganizationContactId": "integer",
"PersonContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"Name": "string",
"RoleId": "string",
"Title": "string",
"RoleStartDate": "string",
"RoleEndDate": "string",
"PhoneAddressSectionVerb": "string",
"Phones": "string",
"Addresses": "string",
"ExsistingRoleSectionVerb": "string",
"ExistingRoles": "string"
}
GET /api/contacts/person/blank/{contactid}
(no description)
OK
POST /api/contacts/person/duplicatecheck
undefined
Request Example
{
"FirstName": "string",
"LastName": "string",
"ContactList": "string",
"ContactsOnly": "boolean"
}
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
]
GET /api/contacts/person/edit/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"IsIndividual": "boolean",
"IsOrg": "boolean",
"IsFamily": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"Name": "string",
"DisplayName": "string",
"GenderId": "string",
"AuditId": "integer"
}
GET /api/contacts/person/emails/{contactid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
POST /api/contacts/person/family/association/create
undefined
Request Example
{
"ContactId": "integer",
"PersonContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"Name": "string"
}
OK
Response Example (200 OK)
{
"FirstName": "string",
"LastName": "string",
"ContactId": "string",
"DisplayOnWeb": "boolean",
"Title": "string",
"RoleId": "string",
"RoleStartDate": "string",
"RoleEndDate": "string",
"IsEmpty": "boolean",
"isDeleted": "boolean",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"ContactAuditId": "integer"
}
GET /api/contacts/person/organizations/edit/{contactroleid}
(no description)
Response Example (200 OK)
{
"ContactRoleId": "integer",
"AuditId": "integer",
"RoleId": "string",
"RoleTypeId": "string",
"Title": "string",
"UpdatedRoleId": "string",
"StartDate": "string",
"EndDate": "string",
"SetAsPrimaryOrganization": "boolean",
"IsActive": "boolean",
"DisplayOnWeb": "boolean",
"PrimaryOrganizationReadonly": "boolean",
"DisplayName": "string",
"CurrentDate": "string"
}
GET /api/contacts/person/organizations/history/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"History": "string"
}
GET /api/contacts/personrelationship/lookup/{contactid}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/persons/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"NotUniqueInSet": "boolean",
"ContactAuditId": "integer",
"Name": "string",
"AdditionalData": "string",
"Title": "string",
"IsStaff": "boolean",
"IsTaxExempt": "boolean",
"DestinationContactId": "integer",
"TaxSet": "string"
}
]
GET /api/contacts/persons/typeahead/{sourcecontactid}
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"NotUniqueInSet": "boolean",
"ContactAuditId": "integer",
"Name": "string",
"AdditionalData": "string",
"Title": "string",
"IsStaff": "boolean",
"IsTaxExempt": "boolean",
"DestinationContactId": "integer",
"TaxSet": "string"
}
]
GET /api/contacts/persons/typeaheadfirstname
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"NotUniqueInSet": "boolean",
"ContactAuditId": "integer",
"Name": "string",
"AdditionalData": "string",
"Title": "string",
"IsStaff": "boolean",
"IsTaxExempt": "boolean",
"DestinationContactId": "integer",
"TaxSet": "string"
}
]
GET /api/contacts/persons/typeaheadlastname
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"NotUniqueInSet": "boolean",
"ContactAuditId": "integer",
"Name": "string",
"AdditionalData": "string",
"Title": "string",
"IsStaff": "boolean",
"IsTaxExempt": "boolean",
"DestinationContactId": "integer",
"TaxSet": "string"
}
]
Get basic info for individual by contact id
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"ContactId": "integer",
"LoginId": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryOrg": "string",
"DisplayName": "string",
"EmailRelayServiceAddress": "string",
"PrimaryEmailAddress": "string",
"Balance": "number",
"OpenTaskCount": "integer",
"Status": "string",
"Tags": "string",
"ProfileImage": "string",
"Actions": "string",
"AuditId": "integer",
"DoNotShowEditName": "boolean"
}
GET /api/contacts/phones/{contactphoneid}
(no description)
OK
Response Example (200 OK)
{
"ContactPhoneId": "integer",
"PhoneId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"PhoneTypeId": "string",
"PhoneNumber": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"PhoneAuditId": "integer"
}
GET /api/contacts/phones/all/{contactid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
Gets a list of emails associated with contact id
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/contacts/representatives/typeahead
(no description)
(no description)
Response Example (200 OK)
[
{
"ContactId": "integer",
"PrimaryContactId": "string",
"Name": "string",
"EmailAddress": "string"
}
]
GET /api/contacts/resend/{contactroleid}
(no description)
OK
Returns current authentication context
Uses the authentication context to return the current authenticated user ids.
OK
Response Example (200 OK)
{
"CurrentUserId": "integer",
"CurrentUserOrgId": "integer",
"CurrentLoginId": "integer",
"ProductType": "string",
"QuickActions": "string",
"QuickActionsV2": "string",
"FamilyQuickAction": "string",
"UserActions": "string",
"UserActionsV2": "string",
"CreateSiteActions": "string",
"HideSwitchAccountMenuItem": "boolean",
"ActionRequired": "boolean",
"V2UIEnabled": "boolean",
"OtherActions": "string"
}
GET /api/contacts/root/changepassword
OK
Response Example (200 OK)
{
"Message": "string",
"SetNewPasswordMessage": "string",
"Username": "string",
"HasTemporaryPassword": "boolean",
"CurrentPassword": "string",
"NewPassword": "string",
"ConfirmPasswod": "string",
"SecurityQuestionId": "string",
"SecurityQuestionAnswer": "string",
"EnablePasswordResetChallenge": "boolean",
"LoginId": "integer"
}
GET /api/contacts/root/changeusername
OK
Response Example (200 OK)
{
"Username": "string",
"NewUsername": "string",
"CurrentPassword": "string"
}
Returns the claims for the caller of the endpoint.
Returns the claims for the caller of the endpoint.
The list of claims that are applicable for the caller.
Response Example (200 OK)
{
"Claims": "string"
}
GET /api/contacts/root/myaccount
OK
Response Example (200 OK)
{
"Edition": "string",
"MyGrowthZoneAccount": "string",
"MyGrowthZoneAccountRealEstate": "string"
}
GET /api/contacts/root/setsecurityquestion
OK
Response Example (200 OK)
{
"Username": "string",
"SecurityQuestionId": "string",
"SecurityQuestionAnswer": "string",
"LoginId": "integer"
}
GET /api/contacts/send/reset/{loginid}
(no description)
OK
GET /api/contacts/staff
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/staff/alltime
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/contacts/staff/duplicatecheck
undefined
Request Example
{
"FirstName": "string",
"LastName": "string",
"ContactList": "string",
"ContactsOnly": "boolean"
}
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
]
GET /api/contacts/staff/statuses/{staffcontactid}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/staff/withtasks
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/staffuser/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"LoginId": "string",
"OrganizationId": "string",
"IsDeletable": "boolean",
"RegistrationToken": "string",
"Login": "string",
"EmailAddress": "string",
"EmailAddressOld": "string",
"IsActive": "boolean",
"FirstName": "string",
"LastName": "string",
"Title": "string",
"RoleId": "string",
"forceSave": "boolean"
}
GET /api/contacts/systemaccess/{contactid}
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"UserList": "string"
}
GET /api/contacts/task/{contactid}/tasks
(no description)
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/contacts/task/{contactid}/tasks
undefined
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactId": "integer",
"Incomplete": "boolean",
"Completed": "boolean",
"Overdue": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/contacts/tenantstaff
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/contacts/tooltip/{contactid}
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/contacts/tributecontact/lookup
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"TributeContactId": "string",
"Name": "string"
}
]
GET /api/contacts/user/{contactid}/{organizationcontactid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"AuditId": "integer",
"LoginId": "string",
"OrganizationId": "string",
"IsDeletable": "boolean",
"RegistrationToken": "string",
"Login": "string",
"EmailAddress": "string",
"EmailAddressOld": "string",
"IsActive": "boolean",
"FirstName": "string",
"LastName": "string",
"Title": "string",
"RoleId": "string",
"forceSave": "boolean"
}
GET /api/contacts/website/{contactwebaddressid}
(no description)
OK
Response Example (200 OK)
{
"ContactWebAddressId": "integer",
"WebAddressId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"WebAddressTypeId": "string",
"Address": "string",
"UrlText": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"WebAddressAuditId": "integer"
}
GET /api/contacts/withassigned
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"Name": "string"
}
]
Schema Definitions
ListViewReturnModel<ContactActivityListItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ContactActivityAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- ContactId: integer
- ByContactId: integer
- ActivityTypeId: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactId": "integer",
"ByContactId": "integer",
"ActivityTypeId": "string",
"Criteria": "string"
}
ExternalActivityLog: object
- ObjectId: integer
- OverrideObjectIdWithUniqueValue: boolean
- IsDeleted: boolean
- Description: string
- ContactId: integer
- ActivityDate: string
- ActivityType: string
Example
{
"ObjectId": "integer",
"OverrideObjectIdWithUniqueValue": "boolean",
"IsDeleted": "boolean",
"Description": "string",
"ContactId": "integer",
"ActivityDate": "string",
"ActivityType": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
OrgTypeAheadItem: object
- Name: string
- AccountNumber: string
- OrganizationContactId: integer
- AuditId: integer
- AdditionalData: string
-
For email line below name
- DestinationContactId: integer
-
For contact merging
- Id: integer
-
For duplicate detection
- Title: string
- StateProvince: string
- City: string
- Address1: string
- Address2: string
- Website: string
- TypeAheadData: string
- TypeAheadItemDisplay: string
- TypeAheadItemTitle: string
Example
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
EmailTypeAheadItem: object
- EmailAddress: string
- EmailAddressId: integer
- ContactName: string
- ContactId: string
- FirstName: string
- LastName: string
- Name: string
Example
{
"EmailAddress": "string",
"EmailAddressId": "integer",
"ContactName": "string",
"ContactId": "string",
"FirstName": "string",
"LastName": "string",
"Name": "string"
}
PersonTypeAheadItem: object
- ContactId: integer
- DisplayName: string
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- NotUniqueInSet: boolean
- ContactAuditId: integer
- Name: string
- AdditionalData: string
- Title: string
-
brought it here in order for TypeAhead to populate the title as well
- IsStaff: boolean
- IsTaxExempt: boolean
- DestinationContactId: integer
-
For contact merging
- TaxSet: string
Example
{
"ContactId": "integer",
"DisplayName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"NotUniqueInSet": "boolean",
"ContactAuditId": "integer",
"Name": "string",
"AdditionalData": "string",
"Title": "string",
"IsStaff": "boolean",
"IsTaxExempt": "boolean",
"DestinationContactId": "integer",
"TaxSet": "string"
}
ContactTypeAheadItem: object
- ContactId: integer
- DisplayName: string
- SystemContactTypeId: string
- Name: string
- ContactDisplayName: string
- EmailAddress: string
- EmailAddressId: string
- PhoneNumber: string
- StateProvince: string
- City: string
- PhoneId: string
- WebAddress: string
- Image: string
- IsContact: boolean
- OriginalIsContact: boolean
- DestinationContactId: integer
-
For contact merging
- MembershipStatusTypeId: string
- Address1: string
- AddressString: string
Example
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
ToContactTypeAheadItem: object
- ToContactId: string
- DisplayName: string
- Name: string
- ContactDisplayName: string
- EmailAddress: string
- EmailAddressId: string
Example
{
"ToContactId": "string",
"DisplayName": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string"
}
PurchaseContactTypeAheadItem: object
- ContactId: integer
- DisplayName: string
- SystemContactTypeId: string
- Name: string
- ContactDisplayName: string
- EmailAddress: string
- EmailAddressId: string
- PhoneNumber: string
- StateProvince: string
- City: string
- PhoneId: string
- WebAddress: string
- Image: string
- IsContact: boolean
- OriginalIsContact: boolean
- DestinationContactId: integer
-
For contact merging
- MembershipStatusTypeId: string
- Address1: string
- AddressString: string
- IsTaxExempt: boolean
- TaxRegionId: string
- ContactTaxSetRate: number
- ContactTaxSetFloatAmount: number
- AccountNumber: string
Example
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string",
"IsTaxExempt": "boolean",
"TaxRegionId": "string",
"ContactTaxSetRate": "number",
"ContactTaxSetFloatAmount": "number",
"AccountNumber": "string"
}
SecondContactTagEntryItem: object
- SponsorContactId: integer
- PrimaryContactId: integer
- Name: string
- AdditionalData: string
Example
{
"SponsorContactId": "integer",
"PrimaryContactId": "integer",
"Name": "string",
"AdditionalData": "string"
}
ContactWithRepresentativeTagEntryItem: object
- ContactId: integer
- PrimaryContactId: string
- Name: string
- EmailAddress: string
Example
{
"ContactId": "integer",
"PrimaryContactId": "string",
"Name": "string",
"EmailAddress": "string"
}
ContactListViewReturnModel: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ContactsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- ContactType: string
- MembershipTypeId: string
- MembershipLevelId: string
- StatusTypeOptions: string
- Criteria: string
- EmailContains: string
- PhoneContains: string
- WebsiteContains: string
- TitleContains: string
- AccountNumber: string
- NameOrAccountNumber: string
- City: string
- Country: string
- StateProvinceLookup: string
- AssignedToId: string
- GroupId: string
- CategoryItemId: string
- Tags: string
- ContactId: string
- TasksAssignedTo: string
- IsStaff: boolean
- HasBalance: boolean
- HasDueOverdueTasks: boolean
- ContactNotInCRM: boolean
- IsContact: integer
- ModifiedSinceUtc: string
- TenantCountry: integer
- ShowContactCountryInAddress: boolean
- TenantOrganizationId: integer
- PotentialAttendeesContact: boolean
- AbandonedMembershipContact: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactType": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"StatusTypeOptions": "string",
"Criteria": "string",
"EmailContains": "string",
"PhoneContains": "string",
"WebsiteContains": "string",
"TitleContains": "string",
"AccountNumber": "string",
"NameOrAccountNumber": "string",
"City": "string",
"Country": "string",
"StateProvinceLookup": "string",
"AssignedToId": "string",
"GroupId": "string",
"CategoryItemId": "string",
"Tags": "string",
"ContactId": "string",
"TasksAssignedTo": "string",
"IsStaff": "boolean",
"HasBalance": "boolean",
"HasDueOverdueTasks": "boolean",
"ContactNotInCRM": "boolean",
"IsContact": "integer",
"ModifiedSinceUtc": "string",
"TenantCountry": "integer",
"ShowContactCountryInAddress": "boolean",
"TenantOrganizationId": "integer",
"PotentialAttendeesContact": "boolean",
"AbandonedMembershipContact": "boolean"
}
SystemAccessLoginInfoModel: object
- ContactId: integer
- UserList: string
Example
{
"ContactId": "integer",
"UserList": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
ContactTagEntryItem: object
- ContactId: integer
- Name: string
Example
{
"ContactId": "integer",
"Name": "string"
}
ImportContact: object
- ContactId: integer
- UniqueId: string
- ModifiedDate: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- Gender: string
- Birthday: string
- CompanyName: string
- Department: string
- JobTitle: string
- BusinessAddress: string
- HomeAddress: string
- MailingAddress: string
- OtherAddress: string
- Email1Address: string
- Email2Address: string
- Email3Address: string
- AssistantTelephoneNumber: string
- BusinessTelephoneNumber: string
- Business2TelephoneNumber: string
- CallbackTelephoneNumber: string
- CarTelephoneNumber: string
- CompanyMainTelephoneNumber: string
- HomeTelephoneNumber: string
- Home2TelephoneNumber: string
- HomeFaxNumber: string
- MobileTelephoneNumber: string
- PrimaryTelephoneNumber: string
Example
{
"ContactId": "integer",
"UniqueId": "string",
"ModifiedDate": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"Gender": "string",
"Birthday": "string",
"CompanyName": "string",
"Department": "string",
"JobTitle": "string",
"BusinessAddress": "string",
"HomeAddress": "string",
"MailingAddress": "string",
"OtherAddress": "string",
"Email1Address": "string",
"Email2Address": "string",
"Email3Address": "string",
"AssistantTelephoneNumber": "string",
"BusinessTelephoneNumber": "string",
"Business2TelephoneNumber": "string",
"CallbackTelephoneNumber": "string",
"CarTelephoneNumber": "string",
"CompanyMainTelephoneNumber": "string",
"HomeTelephoneNumber": "string",
"Home2TelephoneNumber": "string",
"HomeFaxNumber": "string",
"MobileTelephoneNumber": "string",
"PrimaryTelephoneNumber": "string"
}
ImportContactsWizardModel: object
- ImportContactTypeChoiceStep: string
- SelectOptionalColumnsStep: string
- ImportContactsStep: string
- ImportContactConfirmationStep: string
Example
{
"ImportContactTypeChoiceStep": "string",
"SelectOptionalColumnsStep": "string",
"ImportContactsStep": "string",
"ImportContactConfirmationStep": "string"
}
AddEditUserModel: object
- ContactId: integer
- AuditId: integer
- LoginId: string
- OrganizationId: string
- IsDeletable: boolean
- RegistrationToken: string
- Login: string
- EmailAddress: string
- EmailAddressOld: string
- IsActive: boolean
- FirstName: string
- LastName: string
- Title: string
- RoleId: string
- forceSave: boolean
Example
{
"ContactId": "integer",
"AuditId": "integer",
"LoginId": "string",
"OrganizationId": "string",
"IsDeletable": "boolean",
"RegistrationToken": "string",
"Login": "string",
"EmailAddress": "string",
"EmailAddressOld": "string",
"IsActive": "boolean",
"FirstName": "string",
"LastName": "string",
"Title": "string",
"RoleId": "string",
"forceSave": "boolean"
}
EditOrganizationViewModel: object
- ContactId: integer
- AuditId: integer
- Name: string
- AccountNumber: string
- HideAccountNumber: boolean
- forceSave: boolean
- ContactList: string
- Addresses: string
- People: string
- ContactListHash: string
- AddressesHash: string
- PeopleHash: string
- OrgName: string
Example
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string",
"ContactListHash": "string",
"AddressesHash": "string",
"PeopleHash": "string",
"OrgName": "string"
}
PotentialDuplicateEntry: object
- Id: integer
- Name: string
- Description: string
Example
{
"Id": "integer",
"Name": "string",
"Description": "string"
}
ContactDuplicatesByNameCheck: object
- ContactId: string
- Name: string
Example
{
"ContactId": "string",
"Name": "string"
}
ContactDuplicatesCheck: object
- FirstName: string
- LastName: string
- ContactList: string
- ContactsOnly: boolean
- ContactId: string
- Name: string
Example
{
"FirstName": "string",
"LastName": "string",
"ContactList": "string",
"ContactsOnly": "boolean",
"ContactId": "string",
"Name": "string"
}
EditPersonViewModel: object
- ContactId: integer
- AuditId: integer
- IsRealEstateEdition: boolean
- SystemContactTypeId: string
- PrimaryAddressId: string
- PrimaryEmailAddressId: string
- PrimaryPhoneId: string
- PrimaryWebAddressId: string
- PrimaryContactId: string
- forceSave: boolean
- NRDSIsStateAssociation: boolean
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- CommonName: string
- PrimaryTitle: string
- GenderId: string
- AccountNumber: string
- HideAccountNumber: boolean
- DesignationMsg: string
- ContactDesignations: string
- ContactList: string
- Addresses: string
- OrganizationsAndRoles: string
Example
{
"ContactId": "integer",
"AuditId": "integer",
"IsRealEstateEdition": "boolean",
"SystemContactTypeId": "string",
"PrimaryAddressId": "string",
"PrimaryEmailAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryWebAddressId": "string",
"PrimaryContactId": "string",
"forceSave": "boolean",
"NRDSIsStateAssociation": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"GenderId": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"DesignationMsg": "string",
"ContactDesignations": "string",
"ContactList": "string",
"Addresses": "string",
"OrganizationsAndRoles": "string"
}
IndividualDuplicateCheck: object
- FirstName: string
- LastName: string
- ContactList: string
- ContactsOnly: boolean
Example
{
"FirstName": "string",
"LastName": "string",
"ContactList": "string",
"ContactsOnly": "boolean"
}
EditFamilyViewModel: object
- ContactId: integer
- AuditId: integer
- Name: string
- AccountNumber: string
- HideAccountNumber: boolean
- forceSave: boolean
- ContactList: string
- Addresses: string
- People: string
- FamilyName: string
Example
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string",
"FamilyName": "string"
}
AddEditFamilyViewModel: object
- ContactId: integer
- AuditId: integer
- Name: string
- AccountNumber: string
- HideAccountNumber: boolean
- forceSave: boolean
- ContactList: string
- Addresses: string
- People: string
Example
{
"ContactId": "integer",
"AuditId": "integer",
"Name": "string",
"AccountNumber": "string",
"HideAccountNumber": "boolean",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string",
"People": "string"
}
FamilyTypeAheadItem: object
- Name: string
- ContactId: integer
- AuditId: integer
- AdditionalData: string
-
For email line below name
- DestinationContactId: integer
-
For contact merging
- Id: integer
-
For duplicate detection
- Title: string
- StateProvince: string
- City: string
- Address1: string
- Address2: string
- Website: string
Example
{
"Name": "string",
"ContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string"
}
IndividualListItem: object
- FirstName: string
- LastName: string
- ContactId: string
- DisplayOnWeb: boolean
- Title: string
- RoleId: string
- RoleStartDate: string
-
Unused, but required by IAddContactRole
- RoleEndDate: string
-
Unused, but required by IAddContactRole
- IsEmpty: boolean
- isDeleted: boolean
- ContactRoleId: integer
- ContactRoleAuditId: integer
- ContactAuditId: integer
Example
{
"FirstName": "string",
"LastName": "string",
"ContactId": "string",
"DisplayOnWeb": "boolean",
"Title": "string",
"RoleId": "string",
"RoleStartDate": "string",
"RoleEndDate": "string",
"IsEmpty": "boolean",
"isDeleted": "boolean",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"ContactAuditId": "integer"
}
AssociateFamilyWithPersonViewModel: object
- ContactId: integer
- PersonContactId: integer
- AuditId: integer
- ContactRoleId: integer
- ContactRoleAuditId: integer
- Name: string
Example
{
"ContactId": "integer",
"PersonContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"Name": "string"
}
ContactBaseInfoModel: object
- ContactId: integer
- UIVersion: string
- SourceContactId: integer
- SystemContactTypeId: string
- CommContactRelatedOrganizationId: string
- CategoryTypeId: string
- AccountNumber: string
- Name: string
- LoginId: string
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- Designations: string
- DesignationFormatted: string
- CommonName: string
- Title: string
- PrimaryOrg: string
- IsContact: boolean
- DisplayName: string
- ContactDisplayName: string
- ImageDefaultObjectTypeId: integer
- ProfileImage: string
- AllowStatusEdit: boolean
- PrimaryEmailAddress: string
- PrimaryEmailAddressId: string
- HideFinanceEmailStatement: boolean
- Actions: string
- SettingActions: string
- Balance: number
- OpenTaskCount: integer
- EmailRelayServiceAddress: string
- Status: string
- AuditId: integer
- DoNotShowEditName: boolean
- CanBeDeleted: boolean
- HideMergeOrganization: boolean
- HideMergeFamily: boolean
- HideUserLogin: boolean
- HideStaffLogin: boolean
- HideOrganizationLogin: boolean
- Edition: string
- Tags: string
- IsStaff: boolean
- RemoveExtraMessage: string
Example
{
"ContactId": "integer",
"UIVersion": "string",
"SourceContactId": "integer",
"SystemContactTypeId": "string",
"CommContactRelatedOrganizationId": "string",
"CategoryTypeId": "string",
"AccountNumber": "string",
"Name": "string",
"LoginId": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"Designations": "string",
"DesignationFormatted": "string",
"CommonName": "string",
"Title": "string",
"PrimaryOrg": "string",
"IsContact": "boolean",
"DisplayName": "string",
"ContactDisplayName": "string",
"ImageDefaultObjectTypeId": "integer",
"ProfileImage": "string",
"AllowStatusEdit": "boolean",
"PrimaryEmailAddress": "string",
"PrimaryEmailAddressId": "string",
"HideFinanceEmailStatement": "boolean",
"Actions": "string",
"SettingActions": "string",
"Balance": "number",
"OpenTaskCount": "integer",
"EmailRelayServiceAddress": "string",
"Status": "string",
"AuditId": "integer",
"DoNotShowEditName": "boolean",
"CanBeDeleted": "boolean",
"HideMergeOrganization": "boolean",
"HideMergeFamily": "boolean",
"HideUserLogin": "boolean",
"HideStaffLogin": "boolean",
"HideOrganizationLogin": "boolean",
"Edition": "string",
"Tags": "string",
"IsStaff": "boolean",
"RemoveExtraMessage": "string"
}
PersonBaseInfoModel: object
- ContactId: integer
- LoginId: string
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- CommonName: string
- PrimaryOrg: string
- DisplayName: string
- EmailRelayServiceAddress: string
- PrimaryEmailAddress: string
- Balance: number
- OpenTaskCount: integer
- Status: string
- Tags: string
- ProfileImage: string
- Actions: string
- AuditId: integer
- DoNotShowEditName: boolean
Example
{
"ContactId": "integer",
"LoginId": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryOrg": "string",
"DisplayName": "string",
"EmailRelayServiceAddress": "string",
"PrimaryEmailAddress": "string",
"Balance": "number",
"OpenTaskCount": "integer",
"Status": "string",
"Tags": "string",
"ProfileImage": "string",
"Actions": "string",
"AuditId": "integer",
"DoNotShowEditName": "boolean"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
ContactEmailAddressModel: object
- Id: integer
- Name: string
- EmailAddressTypeId: string
Example
{
"Id": "integer",
"Name": "string",
"EmailAddressTypeId": "string"
}
ContactLookUpChoice: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
- EmailAddress: string
- Address1: string
- City: string
- StateProvince: string
- AddressString: string
- AddressId: integer
- EmailAddressId: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"EmailAddress": "string",
"Address1": "string",
"City": "string",
"StateProvince": "string",
"AddressString": "string",
"AddressId": "integer",
"EmailAddressId": "integer"
}
RelatedParentOrgsViewModel: object
- ContactId: integer
- RelatedOrgs: string
Example
{
"ContactId": "integer",
"RelatedOrgs": "string"
}
ContactGeneralInfoSummaryModel: object
- ContactId: integer
- PersonContactId: integer
- ContactOrganizationId: integer
- SystemContactTypeId: string
- CategoryTypeId: string
- PrimaryAddressId: string
- PrimaryWebAddressId: string
- PrimaryPhoneId: string
- PrimaryEmailAddressId: string
- ContactDisplayName: string
- FamilyContactsEnabled: boolean
- RoleRequired: boolean
- IsDeleted: boolean
- ContactInfos: string
- Contacts: string
- Organizations: string
- Groups: string
- Activities: string
- Categories: string
- AssignedContacts: string
- Projects: string
- FormsResponses: string
- Certifications: string
- ShouldTrackCertificateCompletion: boolean
- Memberships: string
- SoftwareAccounts: string
- ContactChapters: string
- IsContactChaptersReadOnly: boolean
- RelatedIndividuals: string
- ContactExperiences: string
- ChildOrganizations: string
- ParentOrganizations: string
- RelatedOrganizations: string
- Communication: string
- SalesOpportunities: string
- Families: string
- FundraisingActivities: string
- AllowStatusEdit: boolean
Example
{
"ContactId": "integer",
"PersonContactId": "integer",
"ContactOrganizationId": "integer",
"SystemContactTypeId": "string",
"CategoryTypeId": "string",
"PrimaryAddressId": "string",
"PrimaryWebAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryEmailAddressId": "string",
"ContactDisplayName": "string",
"FamilyContactsEnabled": "boolean",
"RoleRequired": "boolean",
"IsDeleted": "boolean",
"ContactInfos": "string",
"Contacts": "string",
"Organizations": "string",
"Groups": "string",
"Activities": "string",
"Categories": "string",
"AssignedContacts": "string",
"Projects": "string",
"FormsResponses": "string",
"Certifications": "string",
"ShouldTrackCertificateCompletion": "boolean",
"Memberships": "string",
"SoftwareAccounts": "string",
"ContactChapters": "string",
"IsContactChaptersReadOnly": "boolean",
"RelatedIndividuals": "string",
"ContactExperiences": "string",
"ChildOrganizations": "string",
"ParentOrganizations": "string",
"RelatedOrganizations": "string",
"Communication": "string",
"SalesOpportunities": "string",
"Families": "string",
"FundraisingActivities": "string",
"AllowStatusEdit": "boolean"
}
PersonSelectGroupsViewModel: object
- ContactId: integer
- ContactDisplayName: string
- Groups: string
- GroupMembers: string
Example
{
"ContactId": "integer",
"ContactDisplayName": "string",
"Groups": "string",
"GroupMembers": "string"
}
OrganizationSelectGroupsViewModel: object
- ContactId: integer
- ContactDisplayName: string
- Groups: string
- GroupMembers: string
Example
{
"ContactId": "integer",
"ContactDisplayName": "string",
"Groups": "string",
"GroupMembers": "string"
}
GroupSummaryModel: object
- GroupId: integer
- Name: string
- JoinDate: string
- HideRemoveAction: boolean
- IsPublicViewable: boolean
- Actions: string
- ContactId: integer
- Role: string
- DoNotContact: boolean
- DoNotContactText: string
- ContactGroupId: integer
- EmailAddressId: string
Example
{
"GroupId": "integer",
"Name": "string",
"JoinDate": "string",
"HideRemoveAction": "boolean",
"IsPublicViewable": "boolean",
"Actions": "string",
"ContactId": "integer",
"Role": "string",
"DoNotContact": "boolean",
"DoNotContactText": "string",
"ContactGroupId": "integer",
"EmailAddressId": "string"
}
ContactGroupsViewModel: object
- ContactId: integer
- Items: string
Example
{
"ContactId": "integer",
"Items": "string"
}
PersonSelectCategoriesModel: object
- ContactId: integer
- ContactDisplayName: string
- CategoryTypeId: string
- Categories: string
Example
{
"ContactId": "integer",
"ContactDisplayName": "string",
"CategoryTypeId": "string",
"Categories": "string"
}
BaseSelectCategoriesModel: object
- ContactId: integer
- CategoryListId: integer
- CategoryTypeId: string
- Categories: string
- CategoryListName: string
- DisAllowPrint: boolean
Example
{
"ContactId": "integer",
"CategoryListId": "integer",
"CategoryTypeId": "string",
"Categories": "string",
"CategoryListName": "string",
"DisAllowPrint": "boolean"
}
ContactFieldsViewModel: object
- ContactId: integer
- ObjectTypeId: string
- SearchObjectTypeId: string
- AuditId: integer
- Notes: string
- Bio: string
- EstablishedDate: string
- Naics: string
- Sic: string
- Fields: string
- HasAccessToSetup: boolean
Example
{
"ContactId": "integer",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"AuditId": "integer",
"Notes": "string",
"Bio": "string",
"EstablishedDate": "string",
"Naics": "string",
"Sic": "string",
"Fields": "string",
"HasAccessToSetup": "boolean"
}
ContactMoreInfoViewModel: object
- ContactId: integer
- SystemContactTypeId: string
- SearchObjectTypeId: string
- ObjectTypeId: string
- AuditId: integer
- Fields: string
- Notes: string
- OrgInfo: string
- AddlInfo: string
- HasAccessToSetup: boolean
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"SearchObjectTypeId": "string",
"ObjectTypeId": "string",
"AuditId": "integer",
"Fields": "string",
"Notes": "string",
"OrgInfo": "string",
"AddlInfo": "string",
"HasAccessToSetup": "boolean"
}
AddEditContactNotes: object
- ContactId: integer
- Notes: string
Example
{
"ContactId": "integer",
"Notes": "string"
}
AddEditContactOrgInfo: object
- ContactId: integer
- EstablishedDate: string
- Naics: string
- Sic: string
Example
{
"ContactId": "integer",
"EstablishedDate": "string",
"Naics": "string",
"Sic": "string"
}
AddEditContactAddlInfo: object
- ContactId: integer
- SystemContactTypeId: string
- EstablishedDate: string
- Bio: string
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"EstablishedDate": "string",
"Bio": "string"
}
ContactEngagementModel: object
- ContactId: integer
- HideDownload: boolean
- SystemContactTypeId: string
- DisplayName: string
- RangeStartDate: string
- RangeEndDate: string
- FromDateMessage: string
- AuditId: integer
- OptionalIntroText: string
- MembershipInfo: string
- MembershipMsg: string
- Benefits: string
- BenefitMsg: string
- DirectoryInfo: string
- DirectoryMsg: string
- MemberActivityWidgetData: string
- ResourceAccessInfoWidgetData: string
- LastLogin: string
- ResourceAccessCount: integer
- ContactName: string
- WebMetricsWidgetData: string
- PageViewsCount: integer
- LinkExternalSiteCounts: integer
- LastLoginTime: string
- Balance: number
- GroupCount: integer
- CommunicationWidgetData: string
- EventRegMonthWidgetData: string
- EventRegYearWidgetData: string
- EventRegCount: integer
- EventSponsorCount: integer
- EventExhibitorCount: integer
- AdsCount: integer
- DealsCount: integer
- JobsCount: integer
- EventsCount: integer
- ContEdCompletedCount: integer
- ContEdInProgressCount: integer
- Notes: string
- WidgetData: string
- GroupNames: string
- EventsRegNames: string
- EventsSponsoredNames: string
- EventsExhibitedNames: string
- EventsSubmittedNames: string
- AdNames: string
- DealsNames: string
- JobsNames: string
- IsMetricModuleEnabled: boolean
Example
{
"ContactId": "integer",
"HideDownload": "boolean",
"SystemContactTypeId": "string",
"DisplayName": "string",
"RangeStartDate": "string",
"RangeEndDate": "string",
"FromDateMessage": "string",
"AuditId": "integer",
"OptionalIntroText": "string",
"MembershipInfo": "string",
"MembershipMsg": "string",
"Benefits": "string",
"BenefitMsg": "string",
"DirectoryInfo": "string",
"DirectoryMsg": "string",
"MemberActivityWidgetData": "string",
"ResourceAccessInfoWidgetData": "string",
"LastLogin": "string",
"ResourceAccessCount": "integer",
"ContactName": "string",
"WebMetricsWidgetData": "string",
"PageViewsCount": "integer",
"LinkExternalSiteCounts": "integer",
"LastLoginTime": "string",
"Balance": "number",
"GroupCount": "integer",
"CommunicationWidgetData": "string",
"EventRegMonthWidgetData": "string",
"EventRegYearWidgetData": "string",
"EventRegCount": "integer",
"EventSponsorCount": "integer",
"EventExhibitorCount": "integer",
"AdsCount": "integer",
"DealsCount": "integer",
"JobsCount": "integer",
"EventsCount": "integer",
"ContEdCompletedCount": "integer",
"ContEdInProgressCount": "integer",
"Notes": "string",
"WidgetData": "string",
"GroupNames": "string",
"EventsRegNames": "string",
"EventsSponsoredNames": "string",
"EventsExhibitedNames": "string",
"EventsSubmittedNames": "string",
"AdNames": "string",
"DealsNames": "string",
"JobsNames": "string",
"IsMetricModuleEnabled": "boolean"
}
ContactCategoryItemCollectionItemModel: object
- CategoryListId: integer
- CategoryTypeId: integer
- IsMemberEditable: boolean
- CategoryItemId: integer
- CategoryListName: string
- Name: string
- DisplayOrder: string
- Actions: string
Example
{
"CategoryListId": "integer",
"CategoryTypeId": "integer",
"IsMemberEditable": "boolean",
"CategoryItemId": "integer",
"CategoryListName": "string",
"Name": "string",
"DisplayOrder": "string",
"Actions": "string"
}
MergeContactModel: object
- ContactId: integer
- SourceContactId: integer
- IsStaff: boolean
- forceSave: boolean
- DestinationContactId: integer
- DestinationContactName: string
- TaxSet: string
- Logo: string
- Notes: string
- ShortDescription: string
- Description: string
- Keywords: string
- Highlights: string
- ContactName: string
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- CommonName: string
- Title: string
- EstablishedDate: string
- CustomFields: string
- RealtorCustomFields: string
- BrokerReciprocity: string
- SyncWithNRDS: string
- SyncWithLockbox: string
- SyncWithMLS: string
- NRDSStatus: string
- NRDSMemberId: string
- NRDSOfficeId: string
- NRDSJoinDate: string
- MemberMLSAssociationId: string
- MemberOccupationName: string
- OfficeNMSalesCount: string
- PrimaryState: string
- StopMail: string
- StopFax: string
- StopJunkMail: string
- RealtorOfficeType: string
- OfficeFormalName: string
- MLSOfficeId: string
- MLSId: string
- MLSJoinDate: string
- MLSOfficeLicenseNumber: string
- MLSTermDate: string
- MLSStatus: string
- LockBoxStatusOptions: string
- NRDSPrimaryFieldOfBusiness: string
- LicensingState: string
- NrdsAgentType: string
- DuesWaivedLocal: string
- DuesWaivedState: string
- DuesWaivedNAR: string
- AgentType: string
- EthicsTrainingDate: string
- EducationCourseCode: string
- EducationCourseNumber: string
- COEYear: string
- LocalDesignations: string
- IsSupplementalRecord: string
- NRDSTimestamp: string
- NRDSPreferredFaxType: string
- NRDSPreferredPhoneType: string
- AffiliationId: string
- AssistantContactRelationshipTypeId: string
- CMLSMember: string
- IDPPassword: string
- LocalJoinDate: string
- LockBoxAgentId: string
- LockboxCardStatus: string
- LockBoxExternalId: string
- LockBoxListingAgent: string
- LockboxMemberType: string
- LockBoxOfficeId: string
- LockBoxPass: string
- LockBoxUserName: string
- MemberBirthDate: string
- MemberClass: string
- MemberOrientationDate: string
- MemberSalutation: string
- MemberSubclass: string
- MLSAccessLevel: string
- MLSIDXOfficeParticipation: string
- MLSLoginId: string
- MLSParticipant: string
- MLSWaived: string
- NRDSAddlContactPhoneId: string
- NRDSCellContactPhoneId: string
- NRDSContactEmailAddressId: string
- NRDSPersonalEmailId: string
- NRDSSharedEmailId: string
- NRDSTeamEmailId: string
- NRDSContactPhoneId: string
- NRDSFaxContactPhoneId: string
- NRDSLicenseNumber: string
- NRDSMailingContactAddressId: string
- NRDSPersonWebAddressId: string
- NRDSPhysicalContactAddressId: string
- NRDSPreferredMailType: string
- NRDSPreferredPublicationType: string
- OfficeBrokerMLSId: string
- OfficeContactDRId: string
- OfficeManagerNRDSId: string
- PMArbitrationEthicsPending: string
- PMAssociationID: string
- PMAssociationPOEID: string
- PMBillingDiscount: string
- PMMLSID: string
- PMMLSOnlineStatus: string
- PMMLSOnlineStatusChangedDate: string
- PMNationalDuesPaidDate: string
- PMOnRosterFlag: string
- PMPreviousNonMemberFlag: string
- PMReinstatementCode: string
- PMReinstatementDate: string
- PMStateDuesPaidDate: string
- PMStatusChangedDate: string
- POAssociationID: string
- POAssociationPOEID: string
- POBillingID: string
- POBranchType: string
- POContactUnlicensed: string
- POCorporateLicense: string
- POCorporateName: string
- PODistrict: string
- POFranchiseID: string
- POMainID: string
- POMLSID: string
- POMLSOnlineStatus: string
- POMLSOnlineStatusChangedDate: string
- POOnRoster: string
- POParentCompanyID: string
- POStatusChangedDate: string
- POTaxID: string
- POTimestamp: string
- Remarks: string
- SOAssociationId: string
- SONMSalespersons: string
- SOOfficeNRDSID: string
- SOStatus: string
- SOStatusChangedDate: string
- SOSyncWithNRDS: string
- SOTimestamp: string
- StopEmail: string
- PostActions: string
Example
{
"ContactId": "integer",
"SourceContactId": "integer",
"IsStaff": "boolean",
"forceSave": "boolean",
"DestinationContactId": "integer",
"DestinationContactName": "string",
"TaxSet": "string",
"Logo": "string",
"Notes": "string",
"ShortDescription": "string",
"Description": "string",
"Keywords": "string",
"Highlights": "string",
"ContactName": "string",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"Title": "string",
"EstablishedDate": "string",
"CustomFields": "string",
"RealtorCustomFields": "string",
"BrokerReciprocity": "string",
"SyncWithNRDS": "string",
"SyncWithLockbox": "string",
"SyncWithMLS": "string",
"NRDSStatus": "string",
"NRDSMemberId": "string",
"NRDSOfficeId": "string",
"NRDSJoinDate": "string",
"MemberMLSAssociationId": "string",
"MemberOccupationName": "string",
"OfficeNMSalesCount": "string",
"PrimaryState": "string",
"StopMail": "string",
"StopFax": "string",
"StopJunkMail": "string",
"RealtorOfficeType": "string",
"OfficeFormalName": "string",
"MLSOfficeId": "string",
"MLSId": "string",
"MLSJoinDate": "string",
"MLSOfficeLicenseNumber": "string",
"MLSTermDate": "string",
"MLSStatus": "string",
"LockBoxStatusOptions": "string",
"NRDSPrimaryFieldOfBusiness": "string",
"LicensingState": "string",
"NrdsAgentType": "string",
"DuesWaivedLocal": "string",
"DuesWaivedState": "string",
"DuesWaivedNAR": "string",
"AgentType": "string",
"EthicsTrainingDate": "string",
"EducationCourseCode": "string",
"EducationCourseNumber": "string",
"COEYear": "string",
"LocalDesignations": "string",
"IsSupplementalRecord": "string",
"NRDSTimestamp": "string",
"NRDSPreferredFaxType": "string",
"NRDSPreferredPhoneType": "string",
"AffiliationId": "string",
"AssistantContactRelationshipTypeId": "string",
"CMLSMember": "string",
"IDPPassword": "string",
"LocalJoinDate": "string",
"LockBoxAgentId": "string",
"LockboxCardStatus": "string",
"LockBoxExternalId": "string",
"LockBoxListingAgent": "string",
"LockboxMemberType": "string",
"LockBoxOfficeId": "string",
"LockBoxPass": "string",
"LockBoxUserName": "string",
"MemberBirthDate": "string",
"MemberClass": "string",
"MemberOrientationDate": "string",
"MemberSalutation": "string",
"MemberSubclass": "string",
"MLSAccessLevel": "string",
"MLSIDXOfficeParticipation": "string",
"MLSLoginId": "string",
"MLSParticipant": "string",
"MLSWaived": "string",
"NRDSAddlContactPhoneId": "string",
"NRDSCellContactPhoneId": "string",
"NRDSContactEmailAddressId": "string",
"NRDSPersonalEmailId": "string",
"NRDSSharedEmailId": "string",
"NRDSTeamEmailId": "string",
"NRDSContactPhoneId": "string",
"NRDSFaxContactPhoneId": "string",
"NRDSLicenseNumber": "string",
"NRDSMailingContactAddressId": "string",
"NRDSPersonWebAddressId": "string",
"NRDSPhysicalContactAddressId": "string",
"NRDSPreferredMailType": "string",
"NRDSPreferredPublicationType": "string",
"OfficeBrokerMLSId": "string",
"OfficeContactDRId": "string",
"OfficeManagerNRDSId": "string",
"PMArbitrationEthicsPending": "string",
"PMAssociationID": "string",
"PMAssociationPOEID": "string",
"PMBillingDiscount": "string",
"PMMLSID": "string",
"PMMLSOnlineStatus": "string",
"PMMLSOnlineStatusChangedDate": "string",
"PMNationalDuesPaidDate": "string",
"PMOnRosterFlag": "string",
"PMPreviousNonMemberFlag": "string",
"PMReinstatementCode": "string",
"PMReinstatementDate": "string",
"PMStateDuesPaidDate": "string",
"PMStatusChangedDate": "string",
"POAssociationID": "string",
"POAssociationPOEID": "string",
"POBillingID": "string",
"POBranchType": "string",
"POContactUnlicensed": "string",
"POCorporateLicense": "string",
"POCorporateName": "string",
"PODistrict": "string",
"POFranchiseID": "string",
"POMainID": "string",
"POMLSID": "string",
"POMLSOnlineStatus": "string",
"POMLSOnlineStatusChangedDate": "string",
"POOnRoster": "string",
"POParentCompanyID": "string",
"POStatusChangedDate": "string",
"POTaxID": "string",
"POTimestamp": "string",
"Remarks": "string",
"SOAssociationId": "string",
"SONMSalespersons": "string",
"SOOfficeNRDSID": "string",
"SOStatus": "string",
"SOStatusChangedDate": "string",
"SOSyncWithNRDS": "string",
"SOTimestamp": "string",
"StopEmail": "string",
"PostActions": "string"
}
MembershipSummaryListItem: object
- MembershipId: integer
- MembershipActivationId: integer
- HashedMembershipId: string
- MembershipContactId: integer
- AuditId: integer
- OwnerContactId: integer
- MembershipContactContactId: integer
- Name: string
- Notes: string
- MembershipStatusTypeId: string
- SummaryDescription: string
- StartDate: string
- ExpirationDate: string
- GracePeriodExpirationDate: string
- EndDate: string
- Renewal: string
- InActive: boolean
- Actions: string
- MembershipEndTypeId: string
- MembershipRenewalTypeId: string
- RenewalDate: string
- PurchaseId: string
- InvoiceNumber: string
- Balance: string
- MembershipPurchaseTypeId: string
- IsAlreadyRenewed: boolean
- IsRenewalPaid: boolean
- IsInactive: boolean
- IsInGracePeriod: boolean
- IsInGracePeriodInvoiced: boolean
- IsRenewDeclined: boolean
- DropReasonId: string
- CssClass: string
- PrimaryEmailAddressId: string
- MembershipTypeId: integer
- MembershipLevelId: string
- PlanOrFrequencyId: string
- HasPaymentPlan: boolean
- HasEligiblePaymentPlan: boolean
Example
{
"MembershipId": "integer",
"MembershipActivationId": "integer",
"HashedMembershipId": "string",
"MembershipContactId": "integer",
"AuditId": "integer",
"OwnerContactId": "integer",
"MembershipContactContactId": "integer",
"Name": "string",
"Notes": "string",
"MembershipStatusTypeId": "string",
"SummaryDescription": "string",
"StartDate": "string",
"ExpirationDate": "string",
"GracePeriodExpirationDate": "string",
"EndDate": "string",
"Renewal": "string",
"InActive": "boolean",
"Actions": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"RenewalDate": "string",
"PurchaseId": "string",
"InvoiceNumber": "string",
"Balance": "string",
"MembershipPurchaseTypeId": "string",
"IsAlreadyRenewed": "boolean",
"IsRenewalPaid": "boolean",
"IsInactive": "boolean",
"IsInGracePeriod": "boolean",
"IsInGracePeriodInvoiced": "boolean",
"IsRenewDeclined": "boolean",
"DropReasonId": "string",
"CssClass": "string",
"PrimaryEmailAddressId": "string",
"MembershipTypeId": "integer",
"MembershipLevelId": "string",
"PlanOrFrequencyId": "string",
"HasPaymentPlan": "boolean",
"HasEligiblePaymentPlan": "boolean"
}
SalesOpportunitySummaryModel: object
- SalesOpportunityId: integer
- ContactId: integer
- SalesOpportunityStatus: string
- SalesContactName: string
- OneTimeValue: string
- RecurringValue: string
- EstimatedCloseDate: string
Example
{
"SalesOpportunityId": "integer",
"ContactId": "integer",
"SalesOpportunityStatus": "string",
"SalesContactName": "string",
"OneTimeValue": "string",
"RecurringValue": "string",
"EstimatedCloseDate": "string"
}
RelatedOrgSummary: object
- ContactRelationshipId: integer
- AuditId: integer
- ContactId: integer
- ChildContactId: integer
- ParentContactId: integer
- OrgName: string
- RelatedOrgName: string
- City: string
- Type: string
- Actions: string
Example
{
"ContactRelationshipId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"ChildContactId": "integer",
"ParentContactId": "integer",
"OrgName": "string",
"RelatedOrgName": "string",
"City": "string",
"Type": "string",
"Actions": "string"
}
ContactInfoChangeDefaultModel: object
- ContactId: integer
- InfoTypeId: string
- Emails: string
- Phones: string
- Addresses: string
- WebAddresses: string
Example
{
"ContactId": "integer",
"InfoTypeId": "string",
"Emails": "string",
"Phones": "string",
"Addresses": "string",
"WebAddresses": "string"
}
AddEditEmailAddressViewModel: object
- ContactEmailAddressId: integer
- ContactId: integer
- EmailAddressId: integer
- WarningIcon: string
- Warning: string
- UpdateAllInstances: boolean
- EmailValidityStatusId: string
- EmailAddress: string
- EmailAddressType: string
- AssistantAddress: string
- Note: string
- MarkAsPrimary: boolean
- IsUnpublished: boolean
- RestrictionStatus: string
- AuditId: integer
- EmailAddressAuditId: integer
- DoNotContact: boolean
- DoNotSendMassEmail: boolean
- RestrictionStatusValue: string
- BillingContactId: integer
Example
{
"ContactEmailAddressId": "integer",
"ContactId": "integer",
"EmailAddressId": "integer",
"WarningIcon": "string",
"Warning": "string",
"UpdateAllInstances": "boolean",
"EmailValidityStatusId": "string",
"EmailAddress": "string",
"EmailAddressType": "string",
"AssistantAddress": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"RestrictionStatus": "string",
"AuditId": "integer",
"EmailAddressAuditId": "integer",
"DoNotContact": "boolean",
"DoNotSendMassEmail": "boolean",
"RestrictionStatusValue": "string",
"BillingContactId": "integer"
}
RecheckAndValidateEmailAddressModel: object
- PurchaseId: string
- ContactEmailAddressId: string
- EmailAddressId: integer
- EmailAddress: string
- Status: string
- EmailValiditySourceTypeId: string
- ReportedBy: string
- LastStatusUpdate: string
- BannerMessage: string
- WarningMessage: string
- Actions: string
- NewEmailAddress: string
Example
{
"PurchaseId": "string",
"ContactEmailAddressId": "string",
"EmailAddressId": "integer",
"EmailAddress": "string",
"Status": "string",
"EmailValiditySourceTypeId": "string",
"ReportedBy": "string",
"LastStatusUpdate": "string",
"BannerMessage": "string",
"WarningMessage": "string",
"Actions": "string",
"NewEmailAddress": "string"
}
EditWebAddressViewModel: object
- ContactWebAddressId: integer
- WebAddressId: integer
- ContactId: integer
- UpdateAllInstances: boolean
- WebAddressTypeId: string
- Address: string
- UrlText: string
- Note: string
- MarkAsPrimary: boolean
- IsUnpublished: boolean
- AuditId: integer
- WebAddressAuditId: integer
Example
{
"ContactWebAddressId": "integer",
"WebAddressId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"WebAddressTypeId": "string",
"Address": "string",
"UrlText": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"WebAddressAuditId": "integer"
}
EditAddressViewModel: object
- ContactAddressId: integer
- AddressId: integer
- ContactId: integer
- UpdateAllInstances: boolean
- Address1: string
- Address2: string
- City: string
- StateProvince: string
- PostalCode: string
- CountryId: string
- AddressTypeId: string
- AddressUsageFlagId: string
- Note: string
- MarkAsPrimary: boolean
- IsUnpublished: boolean
- AuditId: integer
- AddressAuditId: integer
- BillingContactId: integer
Example
{
"ContactAddressId": "integer",
"AddressId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"PostalCode": "string",
"CountryId": "string",
"AddressTypeId": "string",
"AddressUsageFlagId": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"AddressAuditId": "integer",
"BillingContactId": "integer"
}
EditPhoneViewModel: object
- ContactPhoneId: integer
- PhoneId: integer
- ContactId: integer
- UpdateAllInstances: boolean
- PhoneTypeId: string
- PhoneNumber: string
- Note: string
- MarkAsPrimary: boolean
- IsUnpublished: boolean
- AuditId: integer
- PhoneAuditId: integer
Example
{
"ContactPhoneId": "integer",
"PhoneId": "integer",
"ContactId": "integer",
"UpdateAllInstances": "boolean",
"PhoneTypeId": "string",
"PhoneNumber": "string",
"Note": "string",
"MarkAsPrimary": "boolean",
"IsUnpublished": "boolean",
"AuditId": "integer",
"PhoneAuditId": "integer"
}
SyncContactDto: object
- AccountNumber: string
- ContactId: integer
- AuditId: integer
- TenantId: integer
- IsDeleted: boolean
- IsContact: boolean
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- DisplayName: string
- Suffix: string
- CommonName: string
- Name: string
- PrimaryTitle: string
- PrimaryEmailAddressId: string
- PrimaryPhoneId: string
- PrimaryWebAddressId: string
- PrimaryAddressId: string
- PrimaryContactId: string
- SystemContactTypeId: string
- MembershipIds: string
- ContactIdsWithThisContactAsPrimary: string
- ContactPhones: string
- ContactWebAdress: string
- ContactEmailAddresses: string
- ContactAddresses: string
- ContactRoles: string
- OrganizationRoles: string
- CustomFields: string
- PrimaryContact: string
Example
{
"AccountNumber": "string",
"ContactId": "integer",
"AuditId": "integer",
"TenantId": "integer",
"IsDeleted": "boolean",
"IsContact": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"DisplayName": "string",
"Suffix": "string",
"CommonName": "string",
"Name": "string",
"PrimaryTitle": "string",
"PrimaryEmailAddressId": "string",
"PrimaryPhoneId": "string",
"PrimaryWebAddressId": "string",
"PrimaryAddressId": "string",
"PrimaryContactId": "string",
"SystemContactTypeId": "string",
"MembershipIds": "string",
"ContactIdsWithThisContactAsPrimary": "string",
"ContactPhones": "string",
"ContactWebAdress": "string",
"ContactEmailAddresses": "string",
"ContactAddresses": "string",
"ContactRoles": "string",
"OrganizationRoles": "string",
"CustomFields": "string",
"PrimaryContact": "string"
}
AddEditContactInfoModel: object
- AuditId: integer
- ContactId: integer
- ContactDisplayName: string
- forceSave: boolean
- ContactList: string
- Addresses: string
Example
{
"AuditId": "integer",
"ContactId": "integer",
"ContactDisplayName": "string",
"forceSave": "boolean",
"ContactList": "string",
"Addresses": "string"
}
PersonBenefitsViewModel: object
- ScreenActions: string
- ListViewItems: string
Example
{
"ScreenActions": "string",
"ListViewItems": "string"
}
ListViewReturnModel<ContactTasksViewModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ContactTasksAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- ContactId: integer
- Incomplete: boolean
- Completed: boolean
- Overdue: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"ContactId": "integer",
"Incomplete": "boolean",
"Completed": "boolean",
"Overdue": "boolean",
"Criteria": "string"
}
PublishedByContactTypeAheadItem: object
- PublishedByContactId: string
- DisplayName: string
- Name: string
- ContactDisplayName: string
Example
{
"PublishedByContactId": "string",
"DisplayName": "string",
"Name": "string",
"ContactDisplayName": "string"
}
OrganizationTagEntryItem: object
- ContactId: integer
- Name: string
- City: string
- StateProvince: string
- EmailAddress: string
Example
{
"ContactId": "integer",
"Name": "string",
"City": "string",
"StateProvince": "string",
"EmailAddress": "string"
}
ContactWithOrgTagEntryItem: object
- ContactId: integer
- ContactName: string
- Name: string
- OrgName: string
- OrganizationContactId: string
- Title: string
Example
{
"ContactId": "integer",
"ContactName": "string",
"Name": "string",
"OrgName": "string",
"OrganizationContactId": "string",
"Title": "string"
}
LogNoteRecipientsModel: object
- Name: string
- Id: integer
- IsSelected: boolean
- PreviouslySelected: boolean
Example
{
"Name": "string",
"Id": "integer",
"IsSelected": "boolean",
"PreviouslySelected": "boolean"
}
SecondContactWithOrgTagEntryItem: object
- SponsorContactId: integer
- PrimaryContactId: integer
- Name: string
- ContactName: string
- AdditionalData: string
- OrgName: string
- OrganizationContactId: string
- Title: string
Example
{
"SponsorContactId": "integer",
"PrimaryContactId": "integer",
"Name": "string",
"ContactName": "string",
"AdditionalData": "string",
"OrgName": "string",
"OrganizationContactId": "string",
"Title": "string"
}
TributeContactTagEntryItem: object
- TributeContactId: string
- Name: string
Example
{
"TributeContactId": "string",
"Name": "string"
}
DonorContactTagEntryItem: object
- ContactId: integer
- Name: string
Example
{
"ContactId": "integer",
"Name": "string"
}
RelatedOrganizationTagEntryItem: object
- RelationshipContactId: integer
- Name: string
- City: string
- StateProvince: string
- EmailAddress: string
Example
{
"RelationshipContactId": "integer",
"Name": "string",
"City": "string",
"StateProvince": "string",
"EmailAddress": "string"
}
AddEditRelatedOrganizationModel: object
- ContactRelationshipId: integer
- AuditId: integer
- ContactId: integer
- RelationshipContactId: integer
- OrganizationId: integer
- ContactName: string
- RelationshipContactName: string
- ContactRelationshipTypeId: string
Example
{
"ContactRelationshipId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"RelationshipContactId": "integer",
"OrganizationId": "integer",
"ContactName": "string",
"RelationshipContactName": "string",
"ContactRelationshipTypeId": "string"
}
RelatedContactTagEntryItem: object
- RelationshipContactId: integer
- Name: string
Example
{
"RelationshipContactId": "integer",
"Name": "string"
}
AddEditRelatedIndividualModel: object
- ContactId: integer
- ContactRelationshipId: integer
- RelationshipContactId: integer
- ContactName: string
- RelationshipContactName: string
- ContactRelationshipTypeId: string
- RelatedContactId: integer
- AuditId: integer
Example
{
"ContactId": "integer",
"ContactRelationshipId": "integer",
"RelationshipContactId": "integer",
"ContactName": "string",
"RelationshipContactName": "string",
"ContactRelationshipTypeId": "string",
"RelatedContactId": "integer",
"AuditId": "integer"
}
EditContactNameViewModel: object
- ContactId: integer
- SystemContactTypeId: string
- IsIndividual: boolean
- IsOrg: boolean
- IsFamily: boolean
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- CommonName: string
- PrimaryTitle: string
- Name: string
- DisplayName: string
- GenderId: string
- AuditId: integer
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"IsIndividual": "boolean",
"IsOrg": "boolean",
"IsFamily": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"Name": "string",
"DisplayName": "string",
"GenderId": "string",
"AuditId": "integer"
}
CustomFieldTabModel: object
- SelectListData: string
- CustomFieldDataTypeId: string
- SelectListDataArray: string
- ContactId: string
- Key: integer
- Id: integer
- CustomFieldId: integer
- Name: string
- DisplayName: string
- Description: string
- CustomFieldType: string
- StandardFieldId: string
- DataSize: string
- FieldGroupName: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsRequiredOriginal: boolean
- IsArchived: boolean
- ScriptVariableName: string
-
Generates a 'script friendly' variable name, e.g. only letters and numbers and can't start with a number
- DisplayOrder: string
- GroupDisplayOrder: string
- ValueId: integer
- ValueAuditId: integer
- ObjectTypeId: string
- ClientParsers: string
- DbParsers: string
- ParsedValue: string
- Value: string
- IsDeleted: boolean
- TableColumns: string
- TotalTableColumns: integer
- ScaleModel: string
- ExternalDataSource: string
- SelectOptions: string
- FileModel: string
- Icon: string
- IsFormResponseValue: boolean
Example
{
"SelectListData": "string",
"CustomFieldDataTypeId": "string",
"SelectListDataArray": "string",
"ContactId": "string",
"Key": "integer",
"Id": "integer",
"CustomFieldId": "integer",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldType": "string",
"StandardFieldId": "string",
"DataSize": "string",
"FieldGroupName": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsRequiredOriginal": "boolean",
"IsArchived": "boolean",
"ScriptVariableName": "string",
"DisplayOrder": "string",
"GroupDisplayOrder": "string",
"ValueId": "integer",
"ValueAuditId": "integer",
"ObjectTypeId": "string",
"ClientParsers": "string",
"DbParsers": "string",
"ParsedValue": "string",
"Value": "string",
"IsDeleted": "boolean",
"TableColumns": "string",
"TotalTableColumns": "integer",
"ScaleModel": "string",
"ExternalDataSource": "string",
"SelectOptions": "string",
"FileModel": "string",
"Icon": "string",
"IsFormResponseValue": "boolean"
}
AddEditOrganizationAssignedContactModel: object
- ContactRelationshipId: integer
- ContactId: integer
- StaffContactId: integer
- OrganizationId: integer
- AuditId: integer
- ContactDisplayName: string
- RelationshipContactId: integer
- ContactRelationshipTypeId: string
Example
{
"ContactRelationshipId": "integer",
"ContactId": "integer",
"StaffContactId": "integer",
"OrganizationId": "integer",
"AuditId": "integer",
"ContactDisplayName": "string",
"RelationshipContactId": "integer",
"ContactRelationshipTypeId": "string"
}
AssociateOrganizationWithPersonViewModel: object
- OrganizationContactId: integer
- PersonContactId: integer
- AuditId: integer
- ContactRoleId: integer
- ContactRoleAuditId: integer
- Name: string
- RoleId: string
- Title: string
- RoleStartDate: string
- RoleEndDate: string
- PhoneAddressSectionVerb: string
- Phones: string
- Addresses: string
- ExsistingRoleSectionVerb: string
- ExistingRoles: string
Example
{
"OrganizationContactId": "integer",
"PersonContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"Name": "string",
"RoleId": "string",
"Title": "string",
"RoleStartDate": "string",
"RoleEndDate": "string",
"PhoneAddressSectionVerb": "string",
"Phones": "string",
"Addresses": "string",
"ExsistingRoleSectionVerb": "string",
"ExistingRoles": "string"
}
EditPersonOrganizationContactPermissionViewModel: object
- ContactRoleId: integer
- AuditId: integer
- RoleId: string
- RoleTypeId: string
- Title: string
- UpdatedRoleId: string
- StartDate: string
- EndDate: string
- SetAsPrimaryOrganization: boolean
- IsActive: boolean
- DisplayOnWeb: boolean
- PrimaryOrganizationReadonly: boolean
- DisplayName: string
- CurrentDate: string
Example
{
"ContactRoleId": "integer",
"AuditId": "integer",
"RoleId": "string",
"RoleTypeId": "string",
"Title": "string",
"UpdatedRoleId": "string",
"StartDate": "string",
"EndDate": "string",
"SetAsPrimaryOrganization": "boolean",
"IsActive": "boolean",
"DisplayOnWeb": "boolean",
"PrimaryOrganizationReadonly": "boolean",
"DisplayName": "string",
"CurrentDate": "string"
}
PersonContactRoleModel: object
- ContactId: integer
- History: string
Example
{
"ContactId": "integer",
"History": "string"
}
OrganizationContactAddNew: object
- ContactId: integer
- AuditId: integer
- ContactRoleId: integer
- ContactRoleAuditId: integer
- PrimaryContactId: string
- forceSave: boolean
- IndividualContactId: integer
- ProjectId: integer
- RoleRequired: boolean
- FirstName: string
- LastName: string
- CommonName: string
- MarkAsPrimary: boolean
- RoleId: string
- Title: string
- DisplayOnWeb: boolean
- RoleStartDate: string
- RoleEndDate: string
- ContactList: string
- Addresses: string
- SystemContactTypeId: string
Example
{
"ContactId": "integer",
"AuditId": "integer",
"ContactRoleId": "integer",
"ContactRoleAuditId": "integer",
"PrimaryContactId": "string",
"forceSave": "boolean",
"IndividualContactId": "integer",
"ProjectId": "integer",
"RoleRequired": "boolean",
"FirstName": "string",
"LastName": "string",
"CommonName": "string",
"MarkAsPrimary": "boolean",
"RoleId": "string",
"Title": "string",
"DisplayOnWeb": "boolean",
"RoleStartDate": "string",
"RoleEndDate": "string",
"ContactList": "string",
"Addresses": "string",
"SystemContactTypeId": "string"
}
EditOrganizationPersonContactPermissionViewModel: object
- ContactId: integer
- SystemContactTypeId: string
- IsIndividual: boolean
- IsOrg: boolean
- IsFamily: boolean
- Prefix: string
- FirstName: string
- MiddleName: string
- LastName: string
- Suffix: string
- CommonName: string
- PrimaryTitle: string
- Name: string
- DisplayName: string
- GenderId: string
- AuditId: integer
- ContactRoleId: integer
- IsAlreadyPrimaryContact: boolean
- OriginalStartDate: string
- OriginalEndDate: string
- OriginalTitle: string
- RoleTypeId: string
- RoleId: string
- Title: string
- UpdatedRoleId: string
- StartDate: string
- EndDate: string
- IsActiveOriginal: boolean
- IsActive: boolean
- DisplayOnWeb: boolean
- MarkAsPrimary: boolean
- SetAsMembershipPrimaryContact: boolean
- OrganizationHasActiveMembership: boolean
- OrganizationMembershipName: string
- OrganizationId: string
- OrganizationName: string
- IsBillingOrPrimaryContact: boolean
- SwappedContactId: string
- CurrentDate: string
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"IsIndividual": "boolean",
"IsOrg": "boolean",
"IsFamily": "boolean",
"Prefix": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Suffix": "string",
"CommonName": "string",
"PrimaryTitle": "string",
"Name": "string",
"DisplayName": "string",
"GenderId": "string",
"AuditId": "integer",
"ContactRoleId": "integer",
"IsAlreadyPrimaryContact": "boolean",
"OriginalStartDate": "string",
"OriginalEndDate": "string",
"OriginalTitle": "string",
"RoleTypeId": "string",
"RoleId": "string",
"Title": "string",
"UpdatedRoleId": "string",
"StartDate": "string",
"EndDate": "string",
"IsActiveOriginal": "boolean",
"IsActive": "boolean",
"DisplayOnWeb": "boolean",
"MarkAsPrimary": "boolean",
"SetAsMembershipPrimaryContact": "boolean",
"OrganizationHasActiveMembership": "boolean",
"OrganizationMembershipName": "string",
"OrganizationId": "string",
"OrganizationName": "string",
"IsBillingOrPrimaryContact": "boolean",
"SwappedContactId": "string",
"CurrentDate": "string"
}
OrganizationContactRoleModel: object
- ContactId: integer
- History: string
Example
{
"ContactId": "integer",
"History": "string"
}
GenericLookUpChoice<String>: object
- Id: string
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
ApplicationRootPage: object
- CurrentUserId: integer
-
Current user contact id.
- CurrentUserOrgId: integer
-
Current user org id.
- CurrentLoginId: integer
-
Current user login id.
- ProductType: string
- QuickActions: string
- QuickActionsV2: string
- FamilyQuickAction: string
- UserActions: string
- UserActionsV2: string
- CreateSiteActions: string
- HideSwitchAccountMenuItem: boolean
- ActionRequired: boolean
- V2UIEnabled: boolean
- OtherActions: string
Example
{
"CurrentUserId": "integer",
"CurrentUserOrgId": "integer",
"CurrentLoginId": "integer",
"ProductType": "string",
"QuickActions": "string",
"QuickActionsV2": "string",
"FamilyQuickAction": "string",
"UserActions": "string",
"UserActionsV2": "string",
"CreateSiteActions": "string",
"HideSwitchAccountMenuItem": "boolean",
"ActionRequired": "boolean",
"V2UIEnabled": "boolean",
"OtherActions": "string"
}
ChangePasswordViewModel: object
- Message: string
- SetNewPasswordMessage: string
- Username: string
- HasTemporaryPassword: boolean
- CurrentPassword: string
- NewPassword: string
- ConfirmPasswod: string
- SecurityQuestionId: string
- SecurityQuestionAnswer: string
- EnablePasswordResetChallenge: boolean
- LoginId: integer
Example
{
"Message": "string",
"SetNewPasswordMessage": "string",
"Username": "string",
"HasTemporaryPassword": "boolean",
"CurrentPassword": "string",
"NewPassword": "string",
"ConfirmPasswod": "string",
"SecurityQuestionId": "string",
"SecurityQuestionAnswer": "string",
"EnablePasswordResetChallenge": "boolean",
"LoginId": "integer"
}
ChangeUsernameViewModel: object
- Username: string
- NewUsername: string
- CurrentPassword: string
Example
{
"Username": "string",
"NewUsername": "string",
"CurrentPassword": "string"
}
SecurityQuestionAnswerModel: object
- Username: string
- SecurityQuestionId: string
- SecurityQuestionAnswer: string
- LoginId: integer
Example
{
"Username": "string",
"SecurityQuestionId": "string",
"SecurityQuestionAnswer": "string",
"LoginId": "integer"
}
AddressLookUpChoice: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
- Usage: string
- Note: string
- Address1: string
- Address2: string
- City: string
- StateProvince: string
- AddressString: string
- AddressId: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"Usage": "string",
"Note": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"StateProvince": "string",
"AddressString": "string",
"AddressId": "integer"
}
EmailLookUpChoice: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
- EmailAddress: string
- EmailAddressId: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer",
"EmailAddress": "string",
"EmailAddressId": "integer"
}
ListViewReturnModel<ContactRepresentativesListViewModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ContactRepresentativesAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- ColumnsToShow: string
- ModelColumns: string
- TenantId: integer
- ContactId: integer
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ColumnsToShow": "string",
"ModelColumns": "string",
"TenantId": "integer",
"ContactId": "integer",
"Criteria": "string"
}
IndividualMemberAccessViewModel: object
- ContactId: integer
- ContactRoleId: integer
- RoleTypeId: string
- IsDisabled: boolean
- MemberRoleId: string
- LoginId: string
- Username: string
- LoginUsername: string
- PasswordResetEmail: string
- DefaultEmailMessage: string
- SendLoginInstructionsEmail: boolean
- SendPasswordResetEmail: boolean
- TemporaryPassword: string
- Password: string
- AccessLevelsAccessLevelWithOrgs: string
- IsSAMLEnabled: boolean
- CssClass: string
- IsDeletable: boolean
- BlockPasswordChange: boolean
- AuditInfo: string
Example
{
"ContactId": "integer",
"ContactRoleId": "integer",
"RoleTypeId": "string",
"IsDisabled": "boolean",
"MemberRoleId": "string",
"LoginId": "string",
"Username": "string",
"LoginUsername": "string",
"PasswordResetEmail": "string",
"DefaultEmailMessage": "string",
"SendLoginInstructionsEmail": "boolean",
"SendPasswordResetEmail": "boolean",
"TemporaryPassword": "string",
"Password": "string",
"AccessLevelsAccessLevelWithOrgs": "string",
"IsSAMLEnabled": "boolean",
"CssClass": "string",
"IsDeletable": "boolean",
"BlockPasswordChange": "boolean",
"AuditInfo": "string"
}
IndividualStaffAccessViewModel: object
- ContactId: integer
- ContactRoleId: integer
- RoleTypeId: string
- MemberRoleId: string
- LoginId: string
- Username: string
- SendLoginInstructionsEmail: boolean
- SendPasswordResetEmail: boolean
- PasswordResetEmail: string
- DefaultEmailMessage: string
- AccessLevelsAccessLevelWithOrgs: string
- AuditInfo: string
Example
{
"ContactId": "integer",
"ContactRoleId": "integer",
"RoleTypeId": "string",
"MemberRoleId": "string",
"LoginId": "string",
"Username": "string",
"SendLoginInstructionsEmail": "boolean",
"SendPasswordResetEmail": "boolean",
"PasswordResetEmail": "string",
"DefaultEmailMessage": "string",
"AccessLevelsAccessLevelWithOrgs": "string",
"AuditInfo": "string"
}
OrganizationMemberAccessViewModel: object
- ContactId: integer
- OrganizationDataAccess: string
Example
{
"ContactId": "integer",
"OrganizationDataAccess": "string"
}
AddEditContactVideoGalleryItem: object
- ContactId: integer
- VideoId: integer
- Url: string
- Name: string
- Description: string
- VideoTypeId: string
- EmbedCode: string
Example
{
"ContactId": "integer",
"VideoId": "integer",
"Url": "string",
"Name": "string",
"Description": "string",
"VideoTypeId": "string",
"EmbedCode": "string"
}
AddEditContactExperienceModel: object
- ContactExperienceItemId: integer
- ContactId: integer
- AuditId: integer
- ExperienceItemTypeId: string
- Education: string
- Work: string
- Volunteer: string
- License: string
Example
{
"ContactExperienceItemId": "integer",
"ContactId": "integer",
"AuditId": "integer",
"ExperienceItemTypeId": "string",
"Education": "string",
"Work": "string",
"Volunteer": "string",
"License": "string"
}
ChartData: object
- series: string
- data: string
- extraStats: string
Example
{
"series": "string",
"data": "string",
"extraStats": "string"
}
ResourceAccessedListModel: object
- ContactId: integer
- SystemContactTypeId: string
- Items: string
- ShowContactNameColumn: boolean
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"Items": "string",
"ShowContactNameColumn": "boolean"
}