GrowthZone REST API 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

GET /api/mic/{contactid}/accountcontactinfo/add

contactid: integer
in path

(no description)

200 OK

OK

GET /api/mic/accountbase

Response Example (200 OK)
{
  "HideRelatedContacts": "boolean",
  "HideReferrals": "boolean",
  "FamiliesDisabled": "boolean",
  "HideBranches": "boolean"
}

GET /api/mic/accountcertificationinfo

Response Example (200 OK)
[
  {
    "CertificationContactId": "integer",
    "Name": "string",
    "Status": "string",
    "CreditsEarned": "string",
    "CreditsRemaining": "string",
    "CompletedDate": "string",
    "Actions": "string"
  }
]

GET /api/mic/accountcontactinfo

Response Example (200 OK)
{
  "DisplayName": "string",
  "CommonName": "string",
  "CommonNameFormatted": "string",
  "PrimaryTitle": "string",
  "Title": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "Designations": "string",
  "DesignationFormatted": "string",
  "ContactDisplayName": "string",
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Actions": "string",
  "AllowEditContactName": "boolean",
  "PersonContactInfo": "string",
  "ContactExperiences": "string",
  "ContactBio": "string",
  "Fields": "string",
  "Groups": "string",
  "Categories": "string",
  "CategoryTypeId": "string",
  "AccountNumber": "string",
  "AccountNumberLabel": "string"
}

POST /api/mic/accountcontactinfo/add

Request Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string"
}
Response Example (200 OK)
[
  {
    "Id": "integer",
    "Type": "string",
    "UniqueId": "string",
    "Name": "string",
    "Value": "string",
    "IsBad": "boolean",
    "SubType": "string",
    "subtype": "integer",
    "Actions": "string"
  }
]

POST /api/mic/accountcontactinfo/address

Request Example
{
  "ContactAddressId": "integer",
  "AddressId": "integer",
  "ContactId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "AddressTypeId": "string",
  "AddressUsageFlagId": "string",
  "Note": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer",
  "AddressAuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/address/{contactaddressid}

contactaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactAddressId": "integer",
  "AddressId": "integer",
  "ContactId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "AddressTypeId": "string",
  "AddressUsageFlagId": "string",
  "Note": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer",
  "AddressAuditId": "integer"
}

DELETE /api/mic/accountcontactinfo/address/{contactaddressid}

contactaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

POST /api/mic/accountcontactinfo/bio

Request Example
{
  "ContactId": "integer",
  "AuditId": "integer",
  "Bio": "string"
}
200 OK

OK

GET /api/mic/accountcontactinfo/bio/{contactid}

contactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "AuditId": "integer",
  "Bio": "string"
}

POST /api/mic/accountcontactinfo/email

Request Example
{
  "ContactEmailAddressId": "integer",
  "AuditId": "integer",
  "EmailAddressId": "integer",
  "EmailAddressAuditId": "integer",
  "ContactId": "integer",
  "EmailValidityStatusId": "string",
  "EmailAddressStatus": "string",
  "EmailAddress": "string",
  "EmailAddressType": "string",
  "AssistantAddress": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "DoNotContact": "boolean",
  "DoNotSendMassEmail": "boolean"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/email/{contactemailaddressid}

contactemailaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactEmailAddressId": "integer",
  "AuditId": "integer",
  "EmailAddressId": "integer",
  "EmailAddressAuditId": "integer",
  "ContactId": "integer",
  "EmailValidityStatusId": "string",
  "EmailAddressStatus": "string",
  "EmailAddress": "string",
  "EmailAddressType": "string",
  "AssistantAddress": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "DoNotContact": "boolean",
  "DoNotSendMassEmail": "boolean"
}

DELETE /api/mic/accountcontactinfo/email/{contactemailaddressid}

contactemailaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/groups

Response Example (200 OK)
{
  "CurrentUserContactId": "integer",
  "Groups": "string",
  "ContactId": "integer",
  "GroupMembers": "string"
}

POST /api/mic/accountcontactinfo/groups

Request Example
{
  "CurrentUserContactId": "integer",
  "Groups": "string",
  "ContactId": "integer",
  "GroupMembers": "string"
}
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"
  }
]

DELETE /api/mic/accountcontactinfo/groups/{groupid}

groupid: integer
in path

(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"
}

POST /api/mic/accountcontactinfo/phone

Request Example
{
  "ContactPhoneId": "integer",
  "PhoneId": "integer",
  "ContactId": "integer",
  "PhoneTypeId": "string",
  "PhoneNumber": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "Note": "string",
  "AuditId": "integer",
  "PhoneAuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/phone/{contactphoneid}

contactphoneid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactPhoneId": "integer",
  "PhoneId": "integer",
  "ContactId": "integer",
  "PhoneTypeId": "string",
  "PhoneNumber": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "Note": "string",
  "AuditId": "integer",
  "PhoneAuditId": "integer"
}

DELETE /api/mic/accountcontactinfo/phone/{contactphoneid}

contactphoneid: integer
in path

(no description)

Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/referothers

Response Example (200 OK)
{
  "Message": "string",
  "TenantName": "string",
  "OrganizationName": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "EmailAddress": "string",
  "MessageToStaff": "string",
  "MentionReferral": "boolean",
  "ThankYouMessage": "string",
  "ShouldMemtionReferral": "string",
  "ContactId": "integer",
  "ContactName": "string"
}

POST /api/mic/accountcontactinfo/referothers

Request Example
{
  "Message": "string",
  "TenantName": "string",
  "OrganizationName": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "EmailAddress": "string",
  "MessageToStaff": "string",
  "MentionReferral": "boolean",
  "ThankYouMessage": "string",
  "ShouldMemtionReferral": "string",
  "ContactId": "integer",
  "ContactName": "string"
}
Response Example (200 OK)
{
  "Message": "string",
  "TenantName": "string",
  "OrganizationName": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "EmailAddress": "string",
  "MessageToStaff": "string",
  "MentionReferral": "boolean",
  "ThankYouMessage": "string",
  "ShouldMemtionReferral": "string",
  "ContactId": "integer",
  "ContactName": "string"
}

GET /api/mic/accountcontactinfo/relatedbranchcontacts/{contactroleid}/{branchorgcontactid}

contactroleid: integer
in path

(no description)

branchorgcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean",
  "BranchOrgContactId": "integer"
}

GET /api/mic/accountcontactinfo/relatedbranchcontacts/add/{contactid}/{branchorgcontactid}

contactid: integer
in path

(no description)

branchorgcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean",
  "BranchOrgContactId": "integer"
}

POST /api/mic/accountcontactinfo/relatedbranchcontacts/edit

Request Example
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean",
  "BranchOrgContactId": "integer"
}
200 OK

OK

POST /api/mic/accountcontactinfo/relatedbranches

Response Example (200 OK)
{
  "Items": "string"
}

POST /api/mic/accountcontactinfo/relatedbranches/{currentusercontactid}

currentusercontactid: integer
in path

(no description)

Request Example
{
  "Items": "string"
}
Response Example (200 OK)
{
  "Items": "string"
}

GET /api/mic/accountcontactinfo/relatedbranches/contacts/{branchorgcontactid}

branchorgcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "BranchOrgContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactOrgDisplayName": "string",
  "Items": "string"
}

POST /api/mic/accountcontactinfo/relatedcontacts

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

DELETE /api/mic/accountcontactinfo/relatedcontacts/{contactroleid}

contactroleid: integer
in path

(no description)

200 OK

OK

POST /api/mic/accountcontactinfo/relatedcontacts/edit

Request Example
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean"
}
200 OK

OK

GET /api/mic/accountcontactinfo/relatedcontacts/edit/{contactroleid}

contactroleid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean"
}

GET /api/mic/accountcontactinfo/relatedfamilies

Response Example (200 OK)
{
  "RelatedContacts": "string"
}

GET /api/mic/accountcontactinfo/relatedorgs

Response Example (200 OK)
{
  "RelatedContacts": "string"
}

POST /api/mic/accountcontactinfo/relatedorgs

Request Example
{
  "RelatedContacts": "string"
}
Response Example (200 OK)
{
  "RelatedContacts": "string"
}

POST /api/mic/accountcontactinfo/webaddress

Request Example
{
  "ContactWebAddressId": "integer",
  "WebAddressId": "integer",
  "ContactId": "integer",
  "WebAddressTypeId": "string",
  "Address": "string",
  "UrlText": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountcontactinfo/webaddress/{contactwebaddressid}

contactwebaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactWebAddressId": "integer",
  "WebAddressId": "integer",
  "ContactId": "integer",
  "WebAddressTypeId": "string",
  "Address": "string",
  "UrlText": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer"
}

DELETE /api/mic/accountcontactinfo/webaddress/{contactwebaddressid}

contactwebaddressid: integer
in path

(no description)

Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

GET /api/mic/accountfinancialinfo

Response Example (200 OK)
{
  "Balances": "string",
  "PaymentProfiles": "string",
  "HasDefaultGateway": "boolean",
  "CanAddPaymentProfiles": "boolean",
  "HidePayBalancesButton": "boolean",
  "OpenInvoices": "string",
  "MembershipBillingItems": "string",
  "ScheduledBillingItems": "string",
  "BillingHistory": "string",
  "HideVoluntaryTerminology": "boolean"
}

POST /api/mic/accountfinancialinfo/paymentprofile

Request Example
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "string"
}
Response Example (200 OK)
{
  "IsRelatedAccount": "boolean",
  "PaymentProfileId": "integer",
  "ContactId": "integer",
  "PaymentProfileTypeId": "string",
  "ContactName": "string",
  "ProfileName": "string",
  "Name": "string",
  "PaymentGatewayTypeId": "string",
  "ProfileRawData": "string",
  "IsReadOnly": "string",
  "Actions": "string"
}

DELETE /api/mic/accountfinancialinfo/paymentprofile/{paymentprofileid}

paymentprofileid: integer
in path

(no description)

200 OK

OK

GET /api/mic/accountfinancialinfo/paymentprofile/lookup

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/accountfinancialinfo/paymentprofile/lookup/{paymentprofileid}/{paymentgatewaytypeid}/{paymentgatewayid}

paymentprofileid: string
in path

(no description)

paymentgatewaytypeid: string
in path

(no description)

paymentgatewayid: string
in path

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]

GET /api/mic/accountfinancialinfoadd/paymentprofile/{paymentprofileid}/{paymentgatewayid}

paymentprofileid: string
in path

(no description)

paymentgatewayid: string
in path

(no description)

Response Example (200 OK)
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "string"
}

GET /api/mic/accountfinancialinfoedit/paymentprofile/{paymentprofileid}

paymentprofileid: string
in path

(no description)

Response Example (200 OK)
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "string"
}

GET /api/mic/accountmembershipinfo

Response Example (200 OK)
[
  {
    "MembershipId": "integer",
    "Membership": "string",
    "Number": "string",
    "PointsUsedValue": "string",
    "PointsRemainingValue": "string",
    "Status": "string",
    "RenewalDate": "string",
    "MembershipEndTypeId": "string",
    "MembershipRenewalTypeId": "string",
    "PublicRenewalUrl": "string",
    "DropReasonId": "string",
    "MembershipStatusTypeId": "string",
    "BillingContactId": "string",
    "PrimaryContactId": "string",
    "OrgPrimaryContactId": "string",
    "OwnerContactId": "integer",
    "IsRelatedAccount": "boolean",
    "HasScheduledBillingItems": "boolean",
    "HasPaymentPlanOptions": "boolean",
    "HidePublicRenewalLink": "boolean",
    "Actions": "string"
  }
]

POST /api/mic/accountmembershipinfo/detail

Request Example
{
  "MembershipId": "integer",
  "OwnerContactId": "integer",
  "Type": "string",
  "Number": "string",
  "Status": "string",
  "JoinDate": "string",
  "DropDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsCourtesy": "boolean",
  "AutomaticPaymentMessage": "string",
  "AutomaticPaymentOption": "string",
  "MembershipTypePaymentGatewayTypeId": "string",
  "MembershipTypePaymentGatewayId": "string",
  "ProfilePaymentGatewayTypeId": "string",
  "ProfilePaymentGatewayId": "string",
  "DefaultPaymentGatewayTypeId": "string",
  "DefaultPaymentGatewayId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "PaymentProfileId": "string",
  "AccountMembershipScheduledBillingItems": "string",
  "ShowPaymentInfo": "boolean",
  "forceSave": "boolean"
}
Response Example (200 OK)
{
  "MembershipId": "integer",
  "OwnerContactId": "integer",
  "Type": "string",
  "Number": "string",
  "Status": "string",
  "JoinDate": "string",
  "DropDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsCourtesy": "boolean",
  "AutomaticPaymentMessage": "string",
  "AutomaticPaymentOption": "string",
  "MembershipTypePaymentGatewayTypeId": "string",
  "MembershipTypePaymentGatewayId": "string",
  "ProfilePaymentGatewayTypeId": "string",
  "ProfilePaymentGatewayId": "string",
  "DefaultPaymentGatewayTypeId": "string",
  "DefaultPaymentGatewayId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "PaymentProfileId": "string",
  "AccountMembershipScheduledBillingItems": "string",
  "ShowPaymentInfo": "boolean",
  "forceSave": "boolean"
}

GET /api/mic/accountmembershipinfo/detail/{membershipid}

membershipid: integer
in path

(no description)

Response Example (200 OK)
{
  "MembershipId": "integer",
  "OwnerContactId": "integer",
  "Type": "string",
  "Number": "string",
  "Status": "string",
  "JoinDate": "string",
  "DropDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsCourtesy": "boolean",
  "AutomaticPaymentMessage": "string",
  "AutomaticPaymentOption": "string",
  "MembershipTypePaymentGatewayTypeId": "string",
  "MembershipTypePaymentGatewayId": "string",
  "ProfilePaymentGatewayTypeId": "string",
  "ProfilePaymentGatewayId": "string",
  "DefaultPaymentGatewayTypeId": "string",
  "DefaultPaymentGatewayId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "PaymentProfileId": "string",
  "AccountMembershipScheduledBillingItems": "string",
  "ShowPaymentInfo": "boolean",
  "forceSave": "boolean"
}

POST /api/mic/accountorgcontactinfo

Request Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string"
}
Response Example (200 OK)
[
  {
    "Id": "integer",
    "Type": "string",
    "UniqueId": "string",
    "Name": "string",
    "Value": "string",
    "IsBad": "boolean",
    "SubType": "string",
    "subtype": "integer",
    "Actions": "string"
  }
]

GET /api/mic/accountorgcontactinfo/{contactid}

contactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string"
}

GET /api/mic/accountorgcontactinfo/{contactid}/{branchorgcontactid}

contactid: integer
in path

(no description)

branchorgcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string",
  "BranchOrgContactId": "integer"
}

POST /api/mic/accountorgcontactinfo/{currentusercontactid}/{branchorgcontactid}

currentusercontactid: integer
in path

(no description)

branchorgcontactid: integer
in path

(no description)

Request Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string",
  "BranchOrgContactId": "integer"
}
Response Example (200 OK)
[
  {
    "Id": "integer",
    "Type": "string",
    "UniqueId": "string",
    "Name": "string",
    "Value": "string",
    "IsBad": "boolean",
    "SubType": "string",
    "subtype": "integer",
    "Actions": "string"
  }
]

POST /api/mic/addeditorgscheduledbilling

Request Example
{
  "ScheduledBillingId": "integer",
  "ContactId": "integer",
  "Description": "string",
  "Quantity": "string",
  "Price": "number",
  "Total": "number",
  "PaymentProfileId": "string",
  "AuditId": "integer",
  "forceSave": "boolean"
}
Response Example (200 OK)
{
  "ScheduledBillingId": "integer",
  "Description": "string",
  "BillFrequencyTypeId": "string",
  "NextBillDate": "string",
  "Quantity": "string",
  "Price": "number",
  "LastBillDate": "string",
  "RemainingCycles": "integer",
  "PaymentProfileName": "string",
  "BillContactName": "string",
  "MembershipId": "string",
  "MembershipName": "string",
  "StartDate": "string",
  "EndDate": "string",
  "PaymentProfile": "string",
  "HideOnInvoice": "string",
  "IsRelatedAccount": "boolean",
  "IsReadOnly": "string",
  "Actions": "string",
  "SaleableItemId": "integer",
  "IsVoluntary": "boolean"
}

POST /api/mic/addeditscheduledbilling

Request Example
{
  "ScheduledBillingId": "integer",
  "ContactId": "integer",
  "Description": "string",
  "Quantity": "string",
  "Price": "number",
  "Total": "number",
  "PaymentProfileId": "string",
  "AuditId": "integer",
  "forceSave": "boolean"
}
Response Example (200 OK)
{
  "ScheduledBillingId": "integer",
  "Description": "string",
  "BillFrequencyTypeId": "string",
  "NextBillDate": "string",
  "Quantity": "string",
  "Price": "number",
  "LastBillDate": "string",
  "RemainingCycles": "integer",
  "PaymentProfileName": "string",
  "BillContactName": "string",
  "MembershipId": "string",
  "MembershipName": "string",
  "StartDate": "string",
  "EndDate": "string",
  "PaymentProfile": "string",
  "HideOnInvoice": "string",
  "IsRelatedAccount": "boolean",
  "IsReadOnly": "string",
  "Actions": "string",
  "SaleableItemId": "integer",
  "IsVoluntary": "boolean"
}

GET /api/mic/addeditscheduledbilling/{scheduledbillingid}

scheduledbillingid: integer
in path

(no description)

Response Example (200 OK)
{
  "ScheduledBillingId": "integer",
  "ContactId": "integer",
  "Description": "string",
  "Quantity": "string",
  "Price": "number",
  "Total": "number",
  "PaymentProfileId": "string",
  "AuditId": "integer",
  "forceSave": "boolean"
}

GET /api/mic/autopayandbilling

Response Example (200 OK)
{
  "HasDefaultGateway": "boolean",
  "CanAddPaymentProfiles": "boolean",
  "BannerMessage": "string",
  "ShowCurrentBalance": "boolean",
  "ShowMakeAPaymentLink": "boolean",
  "PaymentProfiles": "string",
  "MembershipBillingItems": "string",
  "ScheduledBillingItems": "string"
}

POST /api/mic/billinghistory

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationId": "integer",
  "ShowRelatedContacts": "boolean",
  "TransactiontDateBetween": "string",
  "TransactionTypeId": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

POST /api/mic/ccertificationcourses/export

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyCourses": "boolean",
  "AllRelatedContactCourses": "boolean",
  "Courses": "string",
  "Type": "string",
  "Completed": "boolean",
  "NotCompletedSinceDate": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/mic/certification/component/download/list/{certificationcontactid}

certificationcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "CertificationContactId": "integer",
  "Files": "string"
}

GET /api/mic/certificationactivity

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyActivity": "boolean",
  "AllRelatedContactActivity": "boolean",
  "Courses": "string",
  "Type": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

POST /api/mic/certificationactivity/export

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyActivity": "boolean",
  "AllRelatedContactActivity": "boolean",
  "Courses": "string",
  "Type": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/mic/certificationcatalog

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "Criteria": "string"
}
Response Example (200 OK)
[
  {
    "CertificationTypeId": "integer",
    "Name": "string",
    "Description": "string",
    "CreditsRequired": "string",
    "HoursRequired": "string",
    "MemberPrice": "string",
    "Actions": "string",
    "IsApprovalRequired": "boolean",
    "IsInEnrollmentDateRange": "boolean",
    "EnrollmentStartDate": "string",
    "EnrollmentEndDate": "string"
  }
]

GET /api/mic/certificationcomponentdetails/{certificationcomponentid}/{certificationcontactid}

certificationcomponentid: integer
in path

(no description)

certificationcontactid: string
in path

(no description)

Response Example (200 OK)
{
  "CertificationComponentId": "integer",
  "Type": "string",
  "CertificationContactId": "integer",
  "CertificationComponentTypeId": "string",
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "FeeName": "string",
  "FeePrice": "string",
  "Objectives": "string",
  "Documents": "string",
  "ComponentCertificates": "string",
  "ShowComponentCertificates": "boolean"
}

POST /api/mic/certificationcomponentpayment/{certificationcomponentid}

certificationcomponentid: string
in path

(no description)

Request Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationComponentId": "integer",
  "CertificationActivityId": "integer",
  "CertificationContactId": "integer",
  "CertificationTypeComponentId": "integer",
  "SaleableItemId": "string",
  "FeeDescription": "string",
  "CertificationComponentTypeId": "string"
}
200 OK

OK

GET /api/mic/certificationcomponentpayment/{certificationcomponentid}/{certificationactivityid}/{certificationcontactid}

certificationcomponentid: integer
in path

(no description)

certificationactivityid: integer
in path

(no description)

certificationcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationComponentId": "integer",
  "CertificationActivityId": "integer",
  "CertificationContactId": "integer",
  "CertificationTypeComponentId": "integer",
  "SaleableItemId": "string",
  "FeeDescription": "string",
  "CertificationComponentTypeId": "string"
}

GET /api/mic/certificationcontactactivities

skip: string
in query

(no description)

pagesize: string
in query

(no description)

Response Example (200 OK)
[
  {
    "CertificationActivityId": "integer",
    "Caption": "string",
    "CertificationComponentId": "string",
    "CertificationContactId": "integer",
    "Certification": "string",
    "ComponentName": "string",
    "PurchaseId": "string",
    "PaymentId": "string",
    "SaleableItemId": "string",
    "ActivityDate": "string",
    "Description": "string",
    "Actions": "string",
    "HideReceiptButton": "boolean",
    "HidePayFeeButton": "boolean",
    "ApprovedByContactId": "string"
  }
]

POST /api/mic/certificationcontactitems

Request Example
"object"
Response Example (200 OK)
[
  {
    "CertificationContactId": "integer",
    "Certification": "string",
    "SystemCertificationStatusId": "string",
    "CertificationStartDate": "string",
    "CompletedDate": "string",
    "HoursEarned": "number",
    "CreditsEarned": "number",
    "Percentage": "string",
    "PercentComplete": "string",
    "ExpirationDate": "string",
    "CertificationDocumentTemplateId": "string",
    "HasCertificationTemplate": "boolean",
    "HideDownloadCertificationButton": "boolean",
    "HideDownloadCertificationComponentButton": "boolean",
    "ShouldTrackCertificateCompletion": "boolean",
    "ExtraOptions": "string",
    "SettingJson": "string",
    "Actions": "string"
  }
]

GET /api/mic/certificationcourses

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyCourses": "boolean",
  "AllRelatedContactCourses": "boolean",
  "Courses": "string",
  "Type": "string",
  "Completed": "boolean",
  "NotCompletedSinceDate": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/mic/certificationdetail/{certificationtypeid}

certificationtypeid: integer
in path

(no description)

Response Example (200 OK)
{
  "CertificationTypeId": "integer",
  "ContactId": "integer",
  "CertificationContactId": "integer",
  "Name": "string",
  "Description": "string",
  "IsApprovalRequired": "boolean",
  "DetailedCertificationTypeModel": "string",
  "IsInEnrollmentDateRange": "boolean",
  "CertificationTypeObjectives": "string",
  "Documents": "string"
}

GET /api/mic/certificationoverview

Response Example (200 OK)
{
  "CertificationEvents": "string",
  "Certifications": "string",
  "ContactActivities": "string"
}

GET /api/mic/certificationprogresstracker/{certificationcontactid}

certificationcontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "CertificationContactId": "integer",
  "CertificationName": "string",
  "Items": "string"
}

GET /api/mic/certificationregistration/{certificationtypeid}

certificationtypeid: integer
in path

(no description)

Response Example (200 OK)
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationTypeId": "integer",
  "CertificationContactId": "integer",
  "Title": "string",
  "RegistrationType": "string",
  "IsApprovalRequired": "boolean",
  "CertificationTypeName": "string",
  "ShowMessage": "boolean",
  "HideButtons": "boolean",
  "HidePaymentWidget": "boolean",
  "HideApplyButton": "boolean",
  "HideEnrollButton": "boolean",
  "HideFreeApplyButton": "boolean",
  "HideFreeEnrollButton": "boolean",
  "IsFree": "boolean",
  "RegistrationResult": "string",
  "ContactInfo": "string",
  "TermsAndConditions": "string",
  "InvoiceMe": "boolean",
  "CanStoreProfile": "boolean",
  "AllowInvoicing": "boolean"
}

POST /api/mic/certificationregistration/{certificationtypeid}

certificationtypeid: string
in path

(no description)

Request Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationTypeId": "integer",
  "CertificationContactId": "integer",
  "Title": "string",
  "RegistrationType": "string",
  "IsApprovalRequired": "boolean",
  "CertificationTypeName": "string",
  "ShowMessage": "boolean",
  "HideButtons": "boolean",
  "HidePaymentWidget": "boolean",
  "HideApplyButton": "boolean",
  "HideEnrollButton": "boolean",
  "HideFreeApplyButton": "boolean",
  "HideFreeEnrollButton": "boolean",
  "IsFree": "boolean",
  "RegistrationResult": "string",
  "ContactInfo": "string",
  "TermsAndConditions": "string",
  "InvoiceMe": "boolean",
  "CanStoreProfile": "boolean",
  "AllowInvoicing": "boolean"
}
Response Example (200 OK)
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationTypeId": "integer",
  "CertificationContactId": "integer",
  "Title": "string",
  "RegistrationType": "string",
  "IsApprovalRequired": "boolean",
  "CertificationTypeName": "string",
  "ShowMessage": "boolean",
  "HideButtons": "boolean",
  "HidePaymentWidget": "boolean",
  "HideApplyButton": "boolean",
  "HideEnrollButton": "boolean",
  "HideFreeApplyButton": "boolean",
  "HideFreeEnrollButton": "boolean",
  "IsFree": "boolean",
  "RegistrationResult": "string",
  "ContactInfo": "string",
  "TermsAndConditions": "string",
  "InvoiceMe": "boolean",
  "CanStoreProfile": "boolean",
  "AllowInvoicing": "boolean"
}

GET /api/mic/certifications

200 OK

OK

GET /api/mic/communicationpreferences

Response Example (200 OK)
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "IsEmailForumEnabled": "boolean",
  "ShowInvoiceDeliveryMethod": "boolean",
  "InvoiceDeliveryMethodDesc": "string",
  "InvoiceDeliveryMethod": "string",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string",
  "ForumNotificationDesc": "string",
  "ForumSubscriptionFrequencyOptionId": "string",
  "ForumWatchTypeId": "string",
  "ForumTopicWatchTypeId": "string",
  "ForumPreferences": "string"
}

POST /api/mic/communicationpreferences

Request Example
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "IsEmailForumEnabled": "boolean",
  "ShowInvoiceDeliveryMethod": "boolean",
  "InvoiceDeliveryMethodDesc": "string",
  "InvoiceDeliveryMethod": "string",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string",
  "ForumNotificationDesc": "string",
  "ForumSubscriptionFrequencyOptionId": "string",
  "ForumWatchTypeId": "string",
  "ForumTopicWatchTypeId": "string",
  "ForumPreferences": "string"
}
Response Example (200 OK)
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "IsEmailForumEnabled": "boolean",
  "ShowInvoiceDeliveryMethod": "boolean",
  "InvoiceDeliveryMethodDesc": "string",
  "InvoiceDeliveryMethod": "string",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string",
  "ForumNotificationDesc": "string",
  "ForumSubscriptionFrequencyOptionId": "string",
  "ForumWatchTypeId": "string",
  "ForumTopicWatchTypeId": "string",
  "ForumPreferences": "string"
}

GET /api/mic/contact/directorycontact/{contactid}

contactid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "ObjectId": "integer",
  "MicroNet.MMP.Data.IContactActivity.Description": "string",
  "MicroNet.MMP.Data.IContactActivity.OverrideObjectIdWithUniqueValue": "boolean",
  "AuditSourceId": "string",
  "PrimaryKey": "integer",
  "DirectoryContactId": "integer",
  "IsDeleted": "boolean",
  "DirectoryId": "integer",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "ContactId": "integer",
  "DisplayName": "string",
  "DirectoryListingTypeId": "string",
  "AuditId": "integer",
  "AddressId": "string",
  "EmailAddressId": "string",
  "PhoneId": "string",
  "WebAddressId": "string",
  "ParentDirectoryContactId": "string",
  "DisplayPrimaryContact": "boolean",
  "SettingsJson": "string",
  "MembershipId": "string",
  "DisplaySortValue": "string",
  "DirectoryContacts": "string",
  "DirectoryContactCustomFieldValues": "string",
  "DirectoryContactVideos": "string",
  "DirectoryListingUpgrades": "string",
  "SiteDirectoryAppearances": "string",
  "Address": "string",
  "AuditInfo": "string",
  "Contact": "string",
  "Directory": "string",
  "DirectoryContact_ParentDirectoryContactId": "string",
  "DirectoryListingType": "string",
  "EmailAddress": "string",
  "Membership": "string",
  "Phone": "string",
  "WebAddress": "string"
}

GET /api/mic/contactinfo

200 OK

OK

Response Example (200 OK)
{
  "CurrentUserContactId": "integer",
  "LoginId": "integer",
  "HideLogoutStaffMenuItem": "boolean",
  "HideLogoutMemberMenuItem": "boolean",
  "AllowedScreens": "string",
  "FirstName": "string",
  "LastName": "string",
  "OrganizationName": "string",
  "Email": "string",
  "ProfileName": "string",
  "ProfileImage": "string",
  "ContentModuleItems": "string",
  "DirectoryModuleItems": "string",
  "MicLinkItems": "string",
  "UserActions": "string",
  "HideAccountSettingsMenuCondition": "boolean",
  "SwapClaims": "string",
  "UserRoleCount": "integer",
  "SecurityQuestionId": "string",
  "SecurityQuestionAnswer": "string",
  "IsRequirePasswordReset": "boolean"
}

GET /api/mic/contentlists

Response Example (200 OK)
[
  {
    "ContentListId": "integer",
    "ContentTypeId": "string",
    "Name": "string",
    "Description": "string"
  }
]

POST /api/mic/contentlists/{contentlistid}/items

contentlistid: integer
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContentListId": "integer",
  "ContentStatusId": "string",
  "CategoryId": "string",
  "PublishStartDateBetween": "string",
  "ContentCreatedByMe": "boolean",
  "IsCurrent": "boolean",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/mic/contentlists/{contentlistid}/items/{contentitemid}

contentlistid: integer
in path

(no description)

contentitemid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentItemId": "integer",
  "ContentListId": "integer",
  "ContentTitle": "string",
  "ShortDescription": "string",
  "ContactNameLink": "string",
  "ContactName": "string",
  "ContentStatusId": "string",
  "ContentStatus": "string",
  "ContentDate": "string",
  "PublishContentDate": "string",
  "PublishEnd": "string",
  "Description": "string",
  "ContentCategories": "string",
  "Images": "string",
  "ContentAdditionInfoCustomFields": "string",
  "CustomFields": "string",
  "ShowAdditionalFields": "boolean",
  "ContactId": "integer",
  "CurrentUserContactId": "integer",
  "SearchImageUrl": "string",
  "SearchImageShortDescription": "string",
  "FileImageInfoId": "integer",
  "DirectoryContactId": "string",
  "CreatedBy": "integer",
  "HideEdit": "boolean"
}

POST /api/mic/contentlists/{contentlistid}/items/{contentitemid}/add

contentlistid: string
in path

(no description)

contentitemid: string
in path

(no description)

Request Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "EditKey": "string",
  "PricingOptionId": "string",
  "CanChangePublishDates": "boolean",
  "ContactId": "integer",
  "PublishedByContactId": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Tags": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "ShortDescription": "string",
  "CategoryItems": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string"
}
Response Example (200 OK)
{
  "ContentListId": "integer",
  "ContentItemId": "integer",
  "AuditId": "integer",
  "CreatedBy": "integer",
  "ModifiedBy": "integer",
  "Title": "string",
  "ShortDescription": "string",
  "ContactName": "string",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStart": "string",
  "ContentDate": "string",
  "CanEdit": "boolean",
  "HideCancel": "boolean",
  "SearchImageUrl": "string",
  "SearchImageShortDescription": "string",
  "ContentCategoryItems": "string",
  "ContentListImageUrl": "string",
  "ContentListImageShortDescription": "string",
  "HubIconCssClass": "string",
  "DefaultImageUrl": "string",
  "DefaultImageShortDescription": "string",
  "UseHubClass": "boolean",
  "Actions": "string"
}

POST /api/mic/contentlists/{contentlistid}/items/{contentitemid}/cancel

contentlistid: string
in path

(no description)

contentitemid: integer
in path

(no description)

200 OK

OK

DELETE /api/mic/contentlists/{contentlistid}/items/{contentitemid}/delete

contentlistid: string
in path

(no description)

contentitemid: integer
in path

(no description)

200 OK

OK

GET /api/mic/contentlists/{contentlistid}/items/{contentitemid}/edit

contentlistid: string
in path

(no description)

contentitemid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "EditKey": "string",
  "PricingOptionId": "string",
  "CanChangePublishDates": "boolean",
  "ContactId": "integer",
  "PublishedByContactId": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Tags": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "ShortDescription": "string",
  "CategoryItems": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string"
}

POST /api/mic/contentlists/{contentlistid}/items/{contentitemid}/edit

contentlistid: string
in path

(no description)

contentitemid: string
in path

(no description)

Request Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "EditKey": "string",
  "PricingOptionId": "string",
  "CanChangePublishDates": "boolean",
  "ContactId": "integer",
  "PublishedByContactId": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Tags": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "ShortDescription": "string",
  "CategoryItems": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string"
}
Response Example (200 OK)
{
  "ContentListId": "integer",
  "ContentItemId": "integer",
  "AuditId": "integer",
  "CreatedBy": "integer",
  "ModifiedBy": "integer",
  "Title": "string",
  "ShortDescription": "string",
  "ContactName": "string",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStart": "string",
  "ContentDate": "string",
  "CanEdit": "boolean",
  "HideCancel": "boolean",
  "SearchImageUrl": "string",
  "SearchImageShortDescription": "string",
  "ContentCategoryItems": "string",
  "ContentListImageUrl": "string",
  "ContentListImageShortDescription": "string",
  "HubIconCssClass": "string",
  "DefaultImageUrl": "string",
  "DefaultImageShortDescription": "string",
  "UseHubClass": "boolean",
  "Actions": "string"
}

GET /api/mic/contentlists/{contentlistid}/items/new

contentlistid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "EditKey": "string",
  "PricingOptionId": "string",
  "CanChangePublishDates": "boolean",
  "ContactId": "integer",
  "PublishedByContactId": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Tags": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "ShortDescription": "string",
  "CategoryItems": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string"
}

DELETE /api/mic/deletesheduledpayment/{purchaseid}

purchaseid: integer
in path

(no description)

200 OK

OK

POST /api/mic/directory/{directoryid}

directoryid: integer
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "AllowCity": "boolean",
  "AllowPostal": "boolean",
  "AllowState": "boolean",
  "AllowCountry": "boolean",
  "AllowCategory": "boolean",
  "AllowCustomFields": "boolean",
  "Name": "string",
  "City": "string",
  "StateProvince_": "string",
  "PostalCode": "string",
  "Country": "string",
  "ListCategories": "string",
  "CustomFields": "string",
  "Criteria": "string",
  "DirectoryId": "integer"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/mic/directorycontacts/{directorycontactid}

directorycontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "Name": "string",
  "ContactType": "string",
  "DirectoryContactDescription": "string",
  "DirectoryContactOrganizations": "string",
  "DirectoryOrgContacts": "string",
  "DirectoryContactCategories": "string",
  "DirectoryContactMemberships": "string",
  "AdditionalInfo": "string",
  "ContactInfo": "string",
  "Images": "string",
  "Videos": "string",
  "ProfileImage": "string",
  "OrgProfileImage": "string"
}

GET /api/mic/directorycontacts/base/{directorycontactid}

directorycontactid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "DirectoryId": "integer",
  "DirectoryContactId": "integer",
  "name": "string",
  "displayName": "string",
  "Name": "string",
  "Image": "string",
  "images": "string",
  "Visibility": "string",
  "Prefix": "string",
  "CommonName": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "ContactCommonName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrgName": "string"
}

GET /api/mic/directoryfilter/{directoryid}

directoryid: integer
in path

(no description)

Response Example (200 OK)
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "AllowCity": "boolean",
  "AllowPostal": "boolean",
  "AllowState": "boolean",
  "AllowCountry": "boolean",
  "AllowCategory": "boolean",
  "AllowCustomFields": "boolean",
  "Name": "string",
  "City": "string",
  "StateProvince_": "string",
  "PostalCode": "string",
  "Country": "string",
  "ListCategories": "string",
  "CustomFields": "string",
  "Criteria": "string",
  "DirectoryId": "integer"
}

GET /api/mic/directoryfilter/{directoryid}/categories

directoryid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "Values": "string",
    "Selection": "integer"
  }
]

GET /api/mic/directoryfilter/{directoryid}/cities

directoryid: integer
in path

(no description)

this[]: string
in query

(no description)

length: string
in query

(no description)

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/directoryfilter/{directoryid}/countries

directoryid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/directoryfilter/{directoryid}/customfields

directoryid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "Values": "string",
    "Selection": "string"
  }
]

GET /api/mic/directoryfilter/{directoryid}/postalcodes

directoryid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/directoryfilter/{directoryid}/states

directoryid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/directorylisting

Response Example (200 OK)
{
  "ProfileImage": "string",
  "FamilyProfileImage": "string",
  "ContactId": "integer",
  "HideContactDropdown": "boolean",
  "Owner": "string",
  "owner": "string",
  "Title": "string",
  "TooltipMessage": "string",
  "SystemContactTypeId": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "DisableCategories": "boolean",
  "PersonContactInfo": "string",
  "DirectoryListings": "string",
  "DirectoryInfo": "string",
  "Categories": "string",
  "MembershipId": "string",
  "Images": "string",
  "Videos": "string",
  "IsReadOnly": "boolean",
  "visibilityJson": "string",
  "visibility": "string",
  "Visibility": "string",
  "DirectoryId": "integer",
  "DirectoryContactId": "integer",
  "ScreenActions": "string",
  "CssClass": "string",
  "CategoryTypeId": "string",
  "ErrorMessage": "string"
}

POST /api/mic/directorylisting/customfields

Request Example
{
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "DisplayName": "string",
  "DisplaySortValue": "string",
  "Fields": "string",
  "ShowCustomFields": "string",
  "Visibility": "string"
}
Response Example (200 OK)
{
  "ProfileImage": "string",
  "FamilyProfileImage": "string",
  "ContactId": "integer",
  "HideContactDropdown": "boolean",
  "Owner": "string",
  "owner": "string",
  "Title": "string",
  "TooltipMessage": "string",
  "SystemContactTypeId": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "DisableCategories": "boolean",
  "PersonContactInfo": "string",
  "DirectoryListings": "string",
  "DirectoryInfo": "string",
  "Categories": "string",
  "MembershipId": "string",
  "Images": "string",
  "Videos": "string",
  "IsReadOnly": "boolean",
  "visibilityJson": "string",
  "visibility": "string",
  "Visibility": "string",
  "DirectoryId": "integer",
  "DirectoryContactId": "integer",
  "ScreenActions": "string",
  "CssClass": "string",
  "CategoryTypeId": "string",
  "ErrorMessage": "string"
}

GET /api/mic/directorylisting/customfields/{directorycontactid}/load

directorycontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "DisplayName": "string",
  "DisplaySortValue": "string",
  "Fields": "string",
  "ShowCustomFields": "string",
  "Visibility": "string"
}

POST /api/mic/directorylisting/directoryinfo

Request Example
{
  "ContactId": "integer",
  "AuditId": "integer",
  "ShortDescription": "string",
  "Description": "string",
  "Keywords": "string",
  "Highlights": "string"
}
200 OK

OK

GET /api/mic/directorylisting/directoryinfo/{contactid}

contactid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "AuditId": "integer",
  "ShortDescription": "string",
  "Description": "string",
  "Keywords": "string",
  "Highlights": "string"
}

GET /api/mic/directorylisting/lookup

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ContactId": "integer",
    "Owner": "string",
    "ContactInfoAuditId": "integer",
    "ProfileImage": "string",
    "PersonContactInfo": "string",
    "DirectoryListings": "string",
    "DirectoryInfo": "string",
    "CssClass": "string",
    "Categories": "string",
    "Images": "string",
    "Videos": "string",
    "ShowGallery": "boolean",
    "ShowVideo": "boolean",
    "ShowHighlights": "boolean",
    "Visibility": "string",
    "ScreenActions": "string",
    "SystemContactTypeId": "string",
    "CategoryTypeId": "string"
  }
]

GET /api/mic/downloads

OK

Response Example (200 OK)
{
  "ContactId": "integer",
  "Downloads": "string"
}

POST /api/mic/editsheduledpayment

Request Example
{
  "PurchaseId": "integer",
  "PaymentProfileId": "string"
}
200 OK

OK

GET /api/mic/editsheduledpayment/{purchaseid}

purchaseid: integer
in path

(no description)

Response Example (200 OK)
{
  "PurchaseId": "integer",
  "PaymentProfileId": "string"
}

POST /api/mic/event

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "CurrentContactId": "integer",
  "Categories": "string",
  "Calendar": "string",
  "StartDateBetween": "string",
  "IsMembersOnly": "boolean",
  "HasSponsorshipsAvailable": "boolean",
  "IsCurrentlyRegisteredIn": "boolean",
  "IsCurrentlySponsor": "boolean",
  "IsRegistrationOpen": "boolean",
  "EventsICreated": "boolean",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/mic/event/{eventid}

eventid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Name": "string",
  "ContactId": "integer",
  "ContactName": "string",
  "OrganizationId": "string",
  "OrganizationName": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "AddressId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string"
}

POST /api/mic/event/{eventid}

undefined

eventid: string
in path

(no description)

Request Example
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Name": "string",
  "ContactId": "integer",
  "ContactName": "string",
  "OrganizationId": "string",
  "OrganizationName": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "AddressId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string"
}

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Status": "string",
  "EventName": "string",
  "StartDateLocal": "string",
  "StartDate": "string",
  "Description": "string",
  "PublicRegisterUrl": "string",
  "CalendarUrl": "string",
  "HidePublicRegistrationLink": "boolean",
  "HidePurchaseSponsorship": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "EndDateLocal": "string",
  "EndDate": "string",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "IsAllDay": "boolean",
  "EnableRegistration": "boolean",
  "IsCurrentContactRegistered": "boolean",
  "RegistrationMode": "string",
  "ExternalRegistrationModeFlags": "string"
}

GET /api/mic/event/base/{eventid}

eventid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "Name": "string",
  "ContentStatusId": "string",
  "PublicRegisterUrl": "string",
  "HidePublicRegistrationLink": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "EnableRegistration": "boolean",
  "StartDate": "string",
  "EndDate": "string",
  "RegistrationUpdateUrl": "string",
  "RegistrationMode": "string",
  "ExternalRegistrationModeFlags": "string"
}

GET /api/mic/event/detail/{eventid}/{eventdetailid}/{currentusercontactid}/{getsessions}/{getsponsors}

eventid: integer
in path

(no description)

eventdetailid: integer
in path

(no description)

currentusercontactid: string
in path

(no description)

getsessions: boolean
in path

(no description)

getsponsors: boolean
in path

(no description)

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "EventLogoImage": "string",
  "Name": "string",
  "EventDescription": "string",
  "EventHours": "string",
  "HourDescription": "string",
  "Sessions": "string",
  "Pricing": "string",
  "Location": "string",
  "EventCertificationComponents": "string",
  "ContactInfo": "string",
  "Images": "string",
  "ShowImageGallery": "boolean",
  "Videos": "string",
  "EventBasicDetails": "string",
  "EventSponsorDetails": "string",
  "EventRegistrationSummary": "string",
  "EventSponsorSummary": "string",
  "Attendees": "string",
  "PublicRegisterUrl": "string",
  "UpdateRegisterUrl": "string",
  "ChangeStatusUrl": "string",
  "PublicSponsorRegistrationUrl": "string",
  "PublicExhibitorRegistrationUrl": "string",
  "ShowPublicRegistrationLink": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "RegistrationSlots": "string",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "EnableRegistration": "boolean",
  "StartDate": "string",
  "EndDate": "string",
  "ShowRegisteredAttendeesToMembers": "boolean",
  "IsCurrentContactRegistered": "boolean",
  "EventRegistrationId": "string",
  "EventAttendeeId": "string",
  "CanEdit": "boolean",
  "CreatedBy": "integer",
  "ContactId": "integer",
  "HasSessions": "boolean",
  "EnableSessions": "boolean",
  "EventSessionSetupItemCollection": "string",
  "EventSponsorListItemViewModel": "string",
  "EventRegistrationExtraOptionsJson": "string",
  "DisplayNumberOfRegistrants": "boolean",
  "RegistrationMode": "string",
  "SponsorshipRegistrationReqs": "string",
  "ExhibitorRegistrationReqs": "string"
}

GET /api/mic/event/detail/{eventid}/attendees

eventid: integer
in path

(no description)

pagesize: string
in query

(no description)

skip: string
in query

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]

GET /api/mic/event/new

200 OK

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "ContentStatusId": "string",
  "SyncWithGoToWebinar": "boolean",
  "SyncWithZoom": "boolean",
  "SyncWithLMS": "boolean",
  "Name": "string",
  "ContactId": "string",
  "Contact": "string",
  "OrganizationId": "string",
  "Organization": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDateTime": "string",
  "EndDateTime": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string",
  "EnableRegistration": "boolean",
  "EnableSessions": "boolean"
}

POST /api/mic/event/new

undefined

Request Example
{
  "EventId": "integer",
  "ContentStatusId": "string",
  "SyncWithGoToWebinar": "boolean",
  "SyncWithZoom": "boolean",
  "SyncWithLMS": "boolean",
  "Name": "string",
  "ContactId": "string",
  "Contact": "string",
  "OrganizationId": "string",
  "Organization": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDateTime": "string",
  "EndDateTime": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string",
  "EnableRegistration": "boolean",
  "EnableSessions": "boolean"
}

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Status": "string",
  "EventName": "string",
  "StartDateLocal": "string",
  "StartDate": "string",
  "Description": "string",
  "PublicRegisterUrl": "string",
  "CalendarUrl": "string",
  "HidePublicRegistrationLink": "boolean",
  "HidePurchaseSponsorship": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "EndDateLocal": "string",
  "EndDate": "string",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "IsAllDay": "boolean",
  "EnableRegistration": "boolean",
  "IsCurrentContactRegistered": "boolean",
  "RegistrationMode": "string",
  "ExternalRegistrationModeFlags": "string"
}

GET /api/mic/event/sessions/{eventid}

eventid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "EventId": "integer",
  "EventSessionsInfo": "string"
}

GET /api/mic/eventbase

Response Example (200 OK)
{
  "HasVouchers": "boolean"
}

POST /api/mic/files/contact/upload/{folderid}

folderid: string
in path

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "Type": "string",
    "Name": "string",
    "LastModifiedDate": "string",
    "CloudFileProviderId": "string",
    "LastModifiedBy": "string",
    "SizeInBytes": "integer",
    "ContentType": "string",
    "Url": "string",
    "Id": "integer",
    "IsPublic": "boolean",
    "IsShared": "boolean",
    "FolderId": "string",
    "FileId": "string",
    "EditUrl": "string",
    "IsError": "boolean",
    "Exception": "string",
    "IsSystem": "boolean",
    "ContactId": "string",
    "IsReadOnly": "boolean",
    "FileHash": "string",
    "DisableShare": "boolean",
    "DisableOpen": "boolean"
  }
]

POST /api/mic/files/org/upload/{folderid}

folderid: string
in path

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "Type": "string",
    "Name": "string",
    "LastModifiedDate": "string",
    "CloudFileProviderId": "string",
    "LastModifiedBy": "string",
    "SizeInBytes": "integer",
    "ContentType": "string",
    "Url": "string",
    "Id": "integer",
    "IsPublic": "boolean",
    "IsShared": "boolean",
    "FolderId": "string",
    "FileId": "string",
    "EditUrl": "string",
    "IsError": "boolean",
    "Exception": "string",
    "IsSystem": "boolean",
    "ContactId": "string",
    "IsReadOnly": "boolean",
    "FileHash": "string",
    "DisableShare": "boolean",
    "DisableOpen": "boolean"
  }
]

GET /api/mic/forum/lookup/authors

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/forum/terms

Response Example (200 OK)
{
  "Terms": "string"
}

GET /api/mic/forum/topicwatch/{forumtopicid}

forumtopicid: integer
in path

(no description)

200 OK

OK

GET /api/mic/forum/watch/{forumid}

forumid: integer
in path

(no description)

200 OK

OK

GET /api/mic/forumcategory/basicview/{categoryid}/{allmywatching}/{allmypost}/{allmydrafts}

categoryid: integer
in path

(no description)

allmywatching: string
in path

(no description)

allmypost: string
in path

(no description)

allmydrafts: string
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "CategoryId": "integer",
  "CustomSortBy": "string",
  "ActivityDateBetween": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "CategoryId": "integer",
  "ForumList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string"
}

GET /api/mic/forumtopics/{forumid}/{allmywatching}/{allmypost}/{allmydrafts}

forumid: string
in path

(no description)

allmywatching: string
in path

(no description)

allmypost: string
in path

(no description)

allmydrafts: string
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "DirectMessages": "boolean",
  "ForumId": "string",
  "CategoryId": "string",
  "PostedBy": "string",
  "PostedDateBetween": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "ForumTopicList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string",
  "FiteredByMenuDescription": "string",
  "ForumId": "integer",
  "AllMyWatching": "boolean",
  "AllMyPost": "boolean",
  "AllMyDrafts": "boolean",
  "IsForumScreen": "boolean",
  "Actions": "string"
}

POST /api/mic/forumtopics/addcomment

Request Example
{
  "ForumMessageId": "integer",
  "ForumTopicId": "integer",
  "IsReply": "boolean",
  "ParentForumMessageId": "string",
  "ContactId": "integer",
  "IsDraft": "boolean",
  "Body": "string",
  "File": "string"
}
200 OK

OK

GET /api/mic/forumtopics/addcomment/{forumtopicid}/{forummessageid}/{parentforummessageid}

forumtopicid: integer
in path

(no description)

forummessageid: string
in path

(no description)

parentforummessageid: string
in path

(no description)

Response Example (200 OK)
{
  "ForumMessageId": "integer",
  "ForumTopicId": "integer",
  "IsReply": "boolean",
  "ParentForumMessageId": "string",
  "ContactId": "integer",
  "IsDraft": "boolean",
  "Body": "string",
  "File": "string",
  "ReplyHeading": "string"
}

DELETE /api/mic/forumtopics/comments/{forummessageid}

forummessageid: integer
in path

(no description)

200 OK

OK

GET /api/mic/forumtopics/comments/{forumtopicid}/{forummessageid}

forumtopicid: integer
in path

(no description)

forummessageid: string
in path

(no description)

Response Example (200 OK)
{
  "ForumMessageId": "integer",
  "ForumTopicId": "integer",
  "IsReply": "boolean",
  "ParentForumMessageId": "string",
  "ContactId": "integer",
  "IsDraft": "boolean",
  "Body": "string",
  "File": "string"
}

GET /api/mic/forumtopics/drafts

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "DirectMessages": "boolean",
  "ForumId": "string",
  "CategoryId": "string",
  "PostedBy": "string",
  "PostedDateBetween": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "ForumTopicList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string",
  "FiteredByMenuDescription": "string",
  "ForumId": "integer",
  "AllMyWatching": "boolean",
  "AllMyPost": "boolean",
  "AllMyDrafts": "boolean",
  "IsForumScreen": "boolean",
  "Actions": "string"
}

GET /api/mic/forumtopics/forumtopicdetail/{forumtopicid}

forumtopicid: integer
in path

(no description)

Response Example (200 OK)
{
  "ForumTopic": "string",
  "TopicMessageList": "string",
  "ForumTree": "string",
  "ForumTopicId": "integer",
  "ForumId": "integer"
}

GET /api/mic/forumtopics/likecomment/{forumtopicid}/{forummessageid}

forumtopicid: integer
in path

(no description)

forummessageid: integer
in path

(no description)

200 OK

OK

GET /api/mic/forumtopics/posts

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "DirectMessages": "boolean",
  "ForumId": "string",
  "CategoryId": "string",
  "PostedBy": "string",
  "PostedDateBetween": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "ForumTopicList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string",
  "FiteredByMenuDescription": "string",
  "ForumId": "integer",
  "AllMyWatching": "boolean",
  "AllMyPost": "boolean",
  "AllMyDrafts": "boolean",
  "IsForumScreen": "boolean",
  "Actions": "string"
}

GET /api/mic/forumtopics/watching

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "DirectMessages": "boolean",
  "ForumId": "string",
  "CategoryId": "string",
  "PostedBy": "string",
  "PostedDateBetween": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "ForumTopicList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string",
  "FiteredByMenuDescription": "string",
  "ForumId": "integer",
  "AllMyWatching": "boolean",
  "AllMyPost": "boolean",
  "AllMyDrafts": "boolean",
  "IsForumScreen": "boolean",
  "Actions": "string"
}

GET /api/mic/frequencyoption/lookup/

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/groups/{groupid}

groupid: integer
in path

(no description)

Response Example (200 OK)
{
  "GroupId": "integer",
  "Name": "string",
  "Members": "string"
}

GET /api/mic/home

Response Example (200 OK)
{
  "CurrentUserContactId": "integer",
  "HideReferrals": "boolean",
  "HideUpcoming": "boolean",
  "HideAccountBalance": "boolean",
  "ShowPaymentSection": "boolean",
  "MakePaymentSection": "string",
  "WelcomeMessage": "string",
  "Updates": "string",
  "UpcomingEvents": "string",
  "AccountBalance": "string",
  "RefererralMessage": "string"
}

GET /api/mic/loadforumtopicaddedit/{forumid}/{topicid}

forumid: string
in path

(no description)

topicid: string
in path

(no description)

Response Example (200 OK)
{
  "ForumTopicId": "integer",
  "Title": "string",
  "ForumId": "integer",
  "Body": "string",
  "File": "string",
  "Publish": "boolean",
  "PostedByContactId": "integer"
}

GET /api/mic/lookup/forumcategories/hub

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

POST /api/mic/orgaccountcontactinfo/address

Request Example
{
  "ContactAddressId": "integer",
  "AddressId": "integer",
  "ContactId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "AddressTypeId": "string",
  "AddressUsageFlagId": "string",
  "Note": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer",
  "AddressAuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

POST /api/mic/orgaccountcontactinfo/email

Request Example
{
  "ContactEmailAddressId": "integer",
  "AuditId": "integer",
  "EmailAddressId": "integer",
  "EmailAddressAuditId": "integer",
  "ContactId": "integer",
  "EmailValidityStatusId": "string",
  "EmailAddressStatus": "string",
  "EmailAddress": "string",
  "EmailAddressType": "string",
  "AssistantAddress": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "DoNotContact": "boolean",
  "DoNotSendMassEmail": "boolean"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

POST /api/mic/orgaccountcontactinfo/phone

Request Example
{
  "ContactPhoneId": "integer",
  "PhoneId": "integer",
  "ContactId": "integer",
  "PhoneTypeId": "string",
  "PhoneNumber": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "Note": "string",
  "AuditId": "integer",
  "PhoneAuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

POST /api/mic/orgaccountcontactinfo/webaddress

Request Example
{
  "ContactWebAddressId": "integer",
  "WebAddressId": "integer",
  "ContactId": "integer",
  "WebAddressTypeId": "string",
  "Address": "string",
  "UrlText": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer"
}
Response Example (200 OK)
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

POST /api/mic/orgaccountfinancialinfo/paymentprofile

Request Example
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "string"
}
Response Example (200 OK)
{
  "IsRelatedAccount": "boolean",
  "PaymentProfileId": "integer",
  "ContactId": "integer",
  "PaymentProfileTypeId": "string",
  "ContactName": "string",
  "ProfileName": "string",
  "Name": "string",
  "PaymentGatewayTypeId": "string",
  "ProfileRawData": "string",
  "IsReadOnly": "string",
  "Actions": "string"
}

POST /api/mic/organization/{contactid}/categorychoices

contactid: string
in path

(no description)

Request Example
{
  "ContactId": "integer",
  "CategoryListId": "integer",
  "CategoryTypeId": "string",
  "Categories": "string",
  "CategoryListName": "string",
  "DisAllowPrint": "boolean"
}
200 OK

OK

GET /api/mic/organization/{contactid}/categorychoices/{categorytypeid}/{categorylistid}

contactid: integer
in path

(no description)

categorytypeid: string
in path

(no description)

categorylistid: string
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "CategoryListId": "integer",
  "CategoryTypeId": "string",
  "Categories": "string",
  "CategoryListName": "string",
  "DisAllowPrint": "boolean"
}

GET /api/mic/public/contact/typeahead

this[]: string
in query

(no description)

length: string
in query

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ContactId": "integer",
    "Contact": "string"
  }
]

GET /api/mic/public/contact/typeahead/{contactid}

contactid: string
in path

(no description)

this[]: string
in query

(no description)

length: string
in query

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "OrganizationId": "integer",
    "Organization": "string"
  }
]

GET /api/mic/resource/{folderid}

folderid: string
in path

(no description)

filter: string
in query

(no description)

Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

POST /api/mic/resource/{folderid}

folderid: string
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "FolderId": "string",
  "Groups": "string",
  "Category": "string",
  "ResourceType": "string",
  "DateAdded": "string",
  "Criteria": "string",
  "WebDavServerUrl": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/mic/resource/myfiles

Response Example (200 OK)
{
  "FolderId": "string",
  "FolderPath": "string",
  "PathList": "string",
  "PersonFilesUpload": "string",
  "TenantFiles": "string",
  "ContactId": "integer"
}

GET /api/mic/resource/tooltip/{resourceid}

resourceid: integer
in path

(no description)

Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

POST /api/mic/resources/{resourceid}

resourceid: string
in path

(no description)

Request Example
{
  "ResourceId": "integer",
  "AuditId": "integer",
  "ResourceTypeId": "string",
  "Title": "string",
  "Summary": "string",
  "File": "string",
  "Url": "string",
  "VideoUrl": "string",
  "GroupPermissions": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "FileId": "string",
  "Categories": "string",
  "FolderId": "string",
  "SystemFolderTypeId": "string",
  "Tags": "string",
  "ContentType": "string"
}
Response Example (200 OK)
{
  "ResourceId": "string",
  "Type": "string",
  "Title": "string",
  "CleanTitle": "string",
  "ResourceCategories": "string",
  "Summary": "string",
  "ResourceCategoriesCard": "string",
  "ResourceGroups": "string",
  "DateAdded": "string",
  "ResourceTypeId": "string",
  "FileId": "string",
  "ContentType": "string",
  "VerifiedContentType": "string",
  "Url": "string",
  "AuditId": "string",
  "AbsoluteUrl": "string",
  "HubIconCssClass": "string",
  "ImageUrl": "string",
  "UseHubClass": "boolean",
  "Actions": "string",
  "CanEdit": "boolean",
  "CanDelete": "boolean",
  "CreatedBy": "string",
  "ResourceUrl": "string",
  "IsBackOfficeList": "boolean",
  "FolderId": "string"
}

DELETE /api/mic/resources/{resourceid}

resourceid: integer
in path

(no description)

200 OK

OK

GET /api/mic/resources/{resourceid}/{folderid}

resourceid: integer
in path

(no description)

folderid: string
in path

(no description)

Response Example (200 OK)
{
  "ResourceId": "integer",
  "AuditId": "integer",
  "ResourceTypeId": "string",
  "Title": "string",
  "Summary": "string",
  "File": "string",
  "Url": "string",
  "VideoUrl": "string",
  "GroupPermissions": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "FileId": "string",
  "Categories": "string",
  "FolderId": "string",
  "SystemFolderTypeId": "string",
  "Tags": "string",
  "ContentType": "string"
}

GET /api/mic/resources/detail/{resourceid}/{cleantitle}

resourceid: integer
in path

(no description)

cleantitle: string
in path

(no description)

Response Example (200 OK)
{
  "ResourceId": "integer",
  "ResourceTypeId": "string",
  "Title": "string",
  "CleanTitle": "string",
  "CreatedBy": "string",
  "CreatedByText": "string",
  "CreatedById": "integer",
  "DateAdded": "string",
  "DateAddedString": "string",
  "Summary": "string",
  "FileName": "string",
  "File": "string",
  "FileUrl": "string",
  "DownloadAction": "string",
  "ResourceUrl": "string",
  "Image": "string",
  "AbsoluteUrl": "string",
  "GoToLinkAction": "string",
  "Url": "string",
  "Video": "string",
  "FileId": "string",
  "ResourceCategories": "string",
  "ResourceGroups": "string",
  "ContentType": "string",
  "HideEdit": "boolean",
  "HasAccess": "boolean"
}

DELETE /api/mic/resources/folder/{folderid}

folderid: integer
in path

(no description)

200 OK

OK

GET /api/mic/resourcesbase

Response Example (200 OK)
{
  "DisableFileSharing": "boolean"
}

POST /api/mic/saveforumtopic

Request Example
{
  "ForumTopicId": "integer",
  "Title": "string",
  "ForumId": "integer",
  "Body": "string",
  "File": "string",
  "Publish": "boolean",
  "PostedByContactId": "integer"
}
200 OK

OK

GET /api/mic/sorttypes/lookup/forumcategory

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/sorttypes/lookup/forumtopic

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/mic/subscriptionlist/{groupid}

groupid: integer
in path

(no description)

Response Example (200 OK)
{
  "GroupId": "integer",
  "Name": "string",
  "Members": "string"
}

GET /api/mic/subscriptions

Response Example (200 OK)
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string"
}

POST /api/mic/subscriptions

Request Example
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string"
}
Response Example (200 OK)
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string"
}

POST /api/mic/swapclaims

undefined

Request Example
{
  "CurrentUserContactId": "integer",
  "ContactId": "integer"
}
Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

DELETE /api/mic/topics/{forumtopicid}

forumtopicid: integer
in path

(no description)

200 OK

OK

GET /api/mic/vouchers

Response Example (200 OK)
{
  "ContactId": "integer",
  "Vouchers": "string"
}

Schema Definitions

RootViewModel: object

CurrentUserContactId: integer
LoginId: integer
HideLogoutStaffMenuItem: boolean
HideLogoutMemberMenuItem: boolean
AllowedScreens: string
FirstName: string
LastName: string
OrganizationName: string
Email: string
ProfileName: string
ProfileImage: string
ContentModuleItems: string
DirectoryModuleItems: string
MicLinkItems: string
UserActions: string
HideAccountSettingsMenuCondition: boolean
SwapClaims: string
UserRoleCount: integer
SecurityQuestionId: string
SecurityQuestionAnswer: string
IsRequirePasswordReset: boolean
Example
{
  "CurrentUserContactId": "integer",
  "LoginId": "integer",
  "HideLogoutStaffMenuItem": "boolean",
  "HideLogoutMemberMenuItem": "boolean",
  "AllowedScreens": "string",
  "FirstName": "string",
  "LastName": "string",
  "OrganizationName": "string",
  "Email": "string",
  "ProfileName": "string",
  "ProfileImage": "string",
  "ContentModuleItems": "string",
  "DirectoryModuleItems": "string",
  "MicLinkItems": "string",
  "UserActions": "string",
  "HideAccountSettingsMenuCondition": "boolean",
  "SwapClaims": "string",
  "UserRoleCount": "integer",
  "SecurityQuestionId": "string",
  "SecurityQuestionAnswer": "string",
  "IsRequirePasswordReset": "boolean"
}

MemberHomeScreenViewModel: object

CurrentUserContactId: integer
HideReferrals: boolean
HideUpcoming: boolean
HideAccountBalance: boolean
ShowPaymentSection: boolean
MakePaymentSection: string
WelcomeMessage: string
Updates: string
UpcomingEvents: string
AccountBalance: string
RefererralMessage: string
Example
{
  "CurrentUserContactId": "integer",
  "HideReferrals": "boolean",
  "HideUpcoming": "boolean",
  "HideAccountBalance": "boolean",
  "ShowPaymentSection": "boolean",
  "MakePaymentSection": "string",
  "WelcomeMessage": "string",
  "Updates": "string",
  "UpcomingEvents": "string",
  "AccountBalance": "string",
  "RefererralMessage": "string"
}

AccountBaseViewModel: object

HideRelatedContacts: boolean
HideReferrals: boolean
FamiliesDisabled: boolean
HideBranches: boolean
Example
{
  "HideRelatedContacts": "boolean",
  "HideReferrals": "boolean",
  "FamiliesDisabled": "boolean",
  "HideBranches": "boolean"
}

AccountContactInfoViewModel: object

DisplayName: string
CommonName: string
CommonNameFormatted: string
PrimaryTitle: string
Title: string
Prefix: string
FirstName: string
MiddleName: string
LastName: string
Suffix: string
Designations: string
DesignationFormatted: string
ContactDisplayName: string
ContactId: integer
SystemContactTypeId: string
Actions: string
AllowEditContactName: boolean
PersonContactInfo: string
ContactExperiences: string
ContactBio: string
Fields: string
Groups: string
Categories: string
CategoryTypeId: string
AccountNumber: string
AccountNumberLabel: string
Example
{
  "DisplayName": "string",
  "CommonName": "string",
  "CommonNameFormatted": "string",
  "PrimaryTitle": "string",
  "Title": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "Designations": "string",
  "DesignationFormatted": "string",
  "ContactDisplayName": "string",
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Actions": "string",
  "AllowEditContactName": "boolean",
  "PersonContactInfo": "string",
  "ContactExperiences": "string",
  "ContactBio": "string",
  "Fields": "string",
  "Groups": "string",
  "Categories": "string",
  "CategoryTypeId": "string",
  "AccountNumber": "string",
  "AccountNumberLabel": "string"
}

AccountContactInfoBioEditModel: object

ContactId: integer
AuditId: integer
Bio: string
Example
{
  "ContactId": "integer",
  "AuditId": "integer",
  "Bio": "string"
}

Boolean: object

Example
"object"

AccountContactGroupAddModel: object

CurrentUserContactId: integer
Groups: string
ContactId: integer
GroupMembers: string
Example
{
  "CurrentUserContactId": "integer",
  "Groups": "string",
  "ContactId": "integer",
  "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"
}

GroupMembersViewModel: object

GroupId: integer
Name: string
Members: string
Example
{
  "GroupId": "integer",
  "Name": "string",
  "Members": "string"
}

AccountReferOthersViewModel: object

Message: string
TenantName: string
OrganizationName: string
FirstName: string
LastName: string
FullName: string
EmailAddress: string
MessageToStaff: string
MentionReferral: boolean
ThankYouMessage: string
ShouldMemtionReferral: string
ContactId: integer
ContactName: string
Example
{
  "Message": "string",
  "TenantName": "string",
  "OrganizationName": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "EmailAddress": "string",
  "MessageToStaff": "string",
  "MentionReferral": "boolean",
  "ThankYouMessage": "string",
  "ShouldMemtionReferral": "string",
  "ContactId": "integer",
  "ContactName": "string"
}

AccountContactRelatedOrgsViewModel: object

RelatedContacts: string
Example
{
  "RelatedContacts": "string"
}

ListViewReturnModel<AccountContactRelatedContactListItem>: 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"
}

AccountContactRelatedContactsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}

AccountContactRelatedBranchesViewModel: object

Items: string
Example
{
  "Items": "string"
}

AccountContactRelatedBranchContactsViewModel: object

ContactId: integer
BranchOrgContactId: integer
CurrentUserOrgContactId: integer
ContactOrgDisplayName: string
Items: string
Example
{
  "ContactId": "integer",
  "BranchOrgContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactOrgDisplayName": "string",
  "Items": "string"
}

AccountContactRelatedContactAddEditModel: object

ContactId: integer
CurrentUserOrgContactId: integer
ContactRoleId: integer
FirstName: string
LastName: string
Title: string
forceSave: boolean
ContactList: string
Addresses: string
ResendLoginInformation: boolean
CanEditName: boolean
Example
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean"
}

AccountContactRelatedBranchContactEditModel: object

ContactId: integer
CurrentUserOrgContactId: integer
ContactRoleId: integer
FirstName: string
LastName: string
Title: string
forceSave: boolean
ContactList: string
Addresses: string
ResendLoginInformation: boolean
CanEditName: boolean
BranchOrgContactId: integer
Example
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean",
  "BranchOrgContactId": "integer"
}

AccountContactRelatedBranchContactAddModel: object

ContactId: integer
CurrentUserOrgContactId: integer
ContactRoleId: integer
FirstName: string
LastName: string
Title: string
forceSave: boolean
ContactList: string
Addresses: string
ResendLoginInformation: boolean
CanEditName: boolean
BranchOrgContactId: integer
Example
{
  "ContactId": "integer",
  "CurrentUserOrgContactId": "integer",
  "ContactRoleId": "integer",
  "FirstName": "string",
  "LastName": "string",
  "Title": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ResendLoginInformation": "boolean",
  "CanEditName": "boolean",
  "BranchOrgContactId": "integer"
}

Object: object

Example
"object"

AccountContactInfoModel: object

Id: integer
Type: string
UniqueId: string
Name: string
Value: string
IsBad: boolean
SubType: string
subtype: integer
Actions: string
Example
{
  "Id": "integer",
  "Type": "string",
  "UniqueId": "string",
  "Name": "string",
  "Value": "string",
  "IsBad": "boolean",
  "SubType": "string",
  "subtype": "integer",
  "Actions": "string"
}

AccountContactInfoAddModel: object

ContactId: integer
ContactDisplayName: string
forceSave: boolean
ContactList: string
Addresses: string
Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string"
}

AccountOrgContactInfoAddModel: object

ContactId: integer
ContactDisplayName: string
forceSave: boolean
ContactList: string
Addresses: string
ContactOrgDisplayName: string
Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string"
}

AccountOrgBranchContactInfoAddModel: object

ContactId: integer
ContactDisplayName: string
forceSave: boolean
ContactList: string
Addresses: string
ContactOrgDisplayName: string
BranchOrgContactId: integer
Example
{
  "ContactId": "integer",
  "ContactDisplayName": "string",
  "forceSave": "boolean",
  "ContactList": "string",
  "Addresses": "string",
  "ContactOrgDisplayName": "string",
  "BranchOrgContactId": "integer"
}

AccountContactEmailAddEditModel: object

ContactEmailAddressId: integer
AuditId: integer
EmailAddressId: integer
EmailAddressAuditId: integer
ContactId: integer
EmailValidityStatusId: string
EmailAddressStatus: string
EmailAddress: string
EmailAddressType: string
AssistantAddress: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
DoNotContact: boolean
DoNotSendMassEmail: boolean
Example
{
  "ContactEmailAddressId": "integer",
  "AuditId": "integer",
  "EmailAddressId": "integer",
  "EmailAddressAuditId": "integer",
  "ContactId": "integer",
  "EmailValidityStatusId": "string",
  "EmailAddressStatus": "string",
  "EmailAddress": "string",
  "EmailAddressType": "string",
  "AssistantAddress": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "DoNotContact": "boolean",
  "DoNotSendMassEmail": "boolean"
}

AccountOrgContactEmailAddEditModel: object

ContactEmailAddressId: integer
AuditId: integer
EmailAddressId: integer
EmailAddressAuditId: integer
ContactId: integer
EmailValidityStatusId: string
EmailAddressStatus: string
EmailAddress: string
EmailAddressType: string
AssistantAddress: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
DoNotContact: boolean
DoNotSendMassEmail: boolean
Example
{
  "ContactEmailAddressId": "integer",
  "AuditId": "integer",
  "EmailAddressId": "integer",
  "EmailAddressAuditId": "integer",
  "ContactId": "integer",
  "EmailValidityStatusId": "string",
  "EmailAddressStatus": "string",
  "EmailAddress": "string",
  "EmailAddressType": "string",
  "AssistantAddress": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "DoNotContact": "boolean",
  "DoNotSendMassEmail": "boolean"
}

AccountContactPhoneAddEditModel: object

ContactPhoneId: integer
PhoneId: integer
ContactId: integer
PhoneTypeId: string
PhoneNumber: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
Note: string
AuditId: integer
PhoneAuditId: integer
Example
{
  "ContactPhoneId": "integer",
  "PhoneId": "integer",
  "ContactId": "integer",
  "PhoneTypeId": "string",
  "PhoneNumber": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "Note": "string",
  "AuditId": "integer",
  "PhoneAuditId": "integer"
}

AccountOrgContactPhoneAddEditModel: object

ContactPhoneId: integer
PhoneId: integer
ContactId: integer
PhoneTypeId: string
PhoneNumber: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
Note: string
AuditId: integer
PhoneAuditId: integer
Example
{
  "ContactPhoneId": "integer",
  "PhoneId": "integer",
  "ContactId": "integer",
  "PhoneTypeId": "string",
  "PhoneNumber": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "Note": "string",
  "AuditId": "integer",
  "PhoneAuditId": "integer"
}

AccountContactAddressAddEditModel: object

ContactAddressId: integer
AddressId: integer
ContactId: integer
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryId: string
AddressTypeId: string
AddressUsageFlagId: string
Note: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
AuditId: integer
AddressAuditId: integer
Example
{
  "ContactAddressId": "integer",
  "AddressId": "integer",
  "ContactId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "AddressTypeId": "string",
  "AddressUsageFlagId": "string",
  "Note": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer",
  "AddressAuditId": "integer"
}

AccountOrgContactAddressAddEditModel: object

ContactAddressId: integer
AddressId: integer
ContactId: integer
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryId: string
AddressTypeId: string
AddressUsageFlagId: string
Note: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
AuditId: integer
AddressAuditId: integer
Example
{
  "ContactAddressId": "integer",
  "AddressId": "integer",
  "ContactId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "AddressTypeId": "string",
  "AddressUsageFlagId": "string",
  "Note": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer",
  "AddressAuditId": "integer"
}

AccountContactWebAddressAddEditModel: object

ContactWebAddressId: integer
WebAddressId: integer
ContactId: integer
WebAddressTypeId: string
Address: string
UrlText: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
AuditId: integer
Example
{
  "ContactWebAddressId": "integer",
  "WebAddressId": "integer",
  "ContactId": "integer",
  "WebAddressTypeId": "string",
  "Address": "string",
  "UrlText": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer"
}

AccountOrgContactWebAddressAddEditModel: object

ContactWebAddressId: integer
WebAddressId: integer
ContactId: integer
WebAddressTypeId: string
Address: string
UrlText: string
MarkAsPrimary: boolean
UpdateAllInstances: boolean
AuditId: integer
Example
{
  "ContactWebAddressId": "integer",
  "WebAddressId": "integer",
  "ContactId": "integer",
  "WebAddressTypeId": "string",
  "Address": "string",
  "UrlText": "string",
  "MarkAsPrimary": "boolean",
  "UpdateAllInstances": "boolean",
  "AuditId": "integer"
}

AccountMembershipInfoViewModel: object

MembershipId: integer
Membership: string
Number: string
PointsUsedValue: string
PointsRemainingValue: string
Status: string
RenewalDate: string
MembershipEndTypeId: string
MembershipRenewalTypeId: string
PublicRenewalUrl: string
DropReasonId: string
MembershipStatusTypeId: string
BillingContactId: string
PrimaryContactId: string
OrgPrimaryContactId: string
OwnerContactId: integer
IsRelatedAccount: boolean
HasScheduledBillingItems: boolean
HasPaymentPlanOptions: boolean
HidePublicRenewalLink: boolean
Actions: string
Example
{
  "MembershipId": "integer",
  "Membership": "string",
  "Number": "string",
  "PointsUsedValue": "string",
  "PointsRemainingValue": "string",
  "Status": "string",
  "RenewalDate": "string",
  "MembershipEndTypeId": "string",
  "MembershipRenewalTypeId": "string",
  "PublicRenewalUrl": "string",
  "DropReasonId": "string",
  "MembershipStatusTypeId": "string",
  "BillingContactId": "string",
  "PrimaryContactId": "string",
  "OrgPrimaryContactId": "string",
  "OwnerContactId": "integer",
  "IsRelatedAccount": "boolean",
  "HasScheduledBillingItems": "boolean",
  "HasPaymentPlanOptions": "boolean",
  "HidePublicRenewalLink": "boolean",
  "Actions": "string"
}

AccountMembershipDetailInfoViewModel: object

MembershipId: integer
OwnerContactId: integer
Type: string
Number: string
Status: string
JoinDate: string
DropDate: string
StartDate: string
EndDate: string
IsCourtesy: boolean
AutomaticPaymentMessage: string
AutomaticPaymentOption: string
MembershipTypePaymentGatewayTypeId: string
MembershipTypePaymentGatewayId: string
ProfilePaymentGatewayTypeId: string
ProfilePaymentGatewayId: string
DefaultPaymentGatewayTypeId: string
DefaultPaymentGatewayId: string
PaymentGatewayTypeId: string
PaymentGatewayId: string
PaymentProfileId: string
AccountMembershipScheduledBillingItems: string
ShowPaymentInfo: boolean
forceSave: boolean
Example
{
  "MembershipId": "integer",
  "OwnerContactId": "integer",
  "Type": "string",
  "Number": "string",
  "Status": "string",
  "JoinDate": "string",
  "DropDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsCourtesy": "boolean",
  "AutomaticPaymentMessage": "string",
  "AutomaticPaymentOption": "string",
  "MembershipTypePaymentGatewayTypeId": "string",
  "MembershipTypePaymentGatewayId": "string",
  "ProfilePaymentGatewayTypeId": "string",
  "ProfilePaymentGatewayId": "string",
  "DefaultPaymentGatewayTypeId": "string",
  "DefaultPaymentGatewayId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "PaymentProfileId": "string",
  "AccountMembershipScheduledBillingItems": "string",
  "ShowPaymentInfo": "boolean",
  "forceSave": "boolean"
}

AccountFinancialInfoViewModel: object

Balances: string
PaymentProfiles: string
HasDefaultGateway: boolean
CanAddPaymentProfiles: boolean
HidePayBalancesButton: boolean
OpenInvoices: string
MembershipBillingItems: string
ScheduledBillingItems: string
BillingHistory: string
HideVoluntaryTerminology: boolean
Example
{
  "Balances": "string",
  "PaymentProfiles": "string",
  "HasDefaultGateway": "boolean",
  "CanAddPaymentProfiles": "boolean",
  "HidePayBalancesButton": "boolean",
  "OpenInvoices": "string",
  "MembershipBillingItems": "string",
  "ScheduledBillingItems": "string",
  "BillingHistory": "string",
  "HideVoluntaryTerminology": "boolean"
}

AutopayAndBillingViewModel: object

HasDefaultGateway: boolean
CanAddPaymentProfiles: boolean
BannerMessage: string
ShowCurrentBalance: boolean
ShowMakeAPaymentLink: boolean
PaymentProfiles: string
MembershipBillingItems: string
ScheduledBillingItems: string
Example
{
  "HasDefaultGateway": "boolean",
  "CanAddPaymentProfiles": "boolean",
  "BannerMessage": "string",
  "ShowCurrentBalance": "boolean",
  "ShowMakeAPaymentLink": "boolean",
  "PaymentProfiles": "string",
  "MembershipBillingItems": "string",
  "ScheduledBillingItems": "string"
}

AccountFinancialInfoScheduledBillingItemAddEditModel: object

ScheduledBillingId: integer
ContactId: integer
Description: string
Quantity: string
Price: number
Total: number
PaymentProfileId: string
AuditId: integer
forceSave: boolean
Example
{
  "ScheduledBillingId": "integer",
  "ContactId": "integer",
  "Description": "string",
  "Quantity": "string",
  "Price": "number",
  "Total": "number",
  "PaymentProfileId": "string",
  "AuditId": "integer",
  "forceSave": "boolean"
}

AccountScheduledBillingItemModel: object

ScheduledBillingId: integer
Description: string
BillFrequencyTypeId: string
NextBillDate: string
Quantity: string
Price: number
LastBillDate: string
RemainingCycles: integer
PaymentProfileName: string
BillContactName: string
MembershipId: string
MembershipName: string
StartDate: string
EndDate: string
PaymentProfile: string
HideOnInvoice: string
IsRelatedAccount: boolean
IsReadOnly: string
Actions: string
SaleableItemId: integer
IsVoluntary: boolean
Example
{
  "ScheduledBillingId": "integer",
  "Description": "string",
  "BillFrequencyTypeId": "string",
  "NextBillDate": "string",
  "Quantity": "string",
  "Price": "number",
  "LastBillDate": "string",
  "RemainingCycles": "integer",
  "PaymentProfileName": "string",
  "BillContactName": "string",
  "MembershipId": "string",
  "MembershipName": "string",
  "StartDate": "string",
  "EndDate": "string",
  "PaymentProfile": "string",
  "HideOnInvoice": "string",
  "IsRelatedAccount": "boolean",
  "IsReadOnly": "string",
  "Actions": "string",
  "SaleableItemId": "integer",
  "IsVoluntary": "boolean"
}

OrgAccountFinancialInfoScheduledBillingItemAddEditModel: object

ScheduledBillingId: integer
ContactId: integer
Description: string
Quantity: string
Price: number
Total: number
PaymentProfileId: string
AuditId: integer
forceSave: boolean
Example
{
  "ScheduledBillingId": "integer",
  "ContactId": "integer",
  "Description": "string",
  "Quantity": "string",
  "Price": "number",
  "Total": "number",
  "PaymentProfileId": "string",
  "AuditId": "integer",
  "forceSave": "boolean"
}

AccountFinancialInfoPaymentProfileEditModel: object

IsDeletable: boolean
IsHub: boolean
IsAddingCard: boolean
PaymentProfileId: integer
AuditId: integer
PaymentGatewayId: string
PaymentGatewayTypeId: integer
Name: string
TenantName: string
TenantId: integer
ContactId: integer
OrganizationContactId: string
ContactIdHash: string
OrganizationContactIdHash: string
ProfileKey: string
ClientKey: string
TokenId: string
CardType: string
CardLast4: string
IsCC: boolean
IsExistingCC: boolean
CanAddBankAccount: boolean
PaymentProfileTypeId: integer
Unverified: boolean
ManageDpmProfilesAction: string
CreditCardInfo: string
BankInfo: string
BankCountries: string
CountryCode: string
AccountId: string
CardExpMonth: string
CardExpYear: string
TwoCardExpYear: string
UpdateCardMessage: string
CannotUpdateCardMessage: string
VerificationAmountOne: string
VerificationAmountTwo: string
PaymentProfileAssociatedItems: string
ConfigInfoJson: string
Address: string
City: string
State: string
PostalCode: string
Currency: string
ContactName: string
IsTestCard: boolean
PayerName: string
Email: string
Country: string
CurrencyType: string
IsTestBank: boolean
IsSavingsAccount: boolean
PreferredEmailAddress: string
AccountLast4: string
BankName: string
CssClass: string
NarPaymentsBaseUrl: string
NRDSMemberId: string
ContactNRDSMemberId: string
DefaultNRDSMemberId: string
AccountNumber: string
RoutingNumber: string
AccountHolderType: string
FirstName: string
LastName: string
Example
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "string"
}

AccountPaymentProfileItemModel: object

IsRelatedAccount: boolean
PaymentProfileId: integer
ContactId: integer
PaymentProfileTypeId: string
ContactName: string
ProfileName: string
Name: string
PaymentGatewayTypeId: string
ProfileRawData: string
IsReadOnly: string
Actions: string
Example
{
  "IsRelatedAccount": "boolean",
  "PaymentProfileId": "integer",
  "ContactId": "integer",
  "PaymentProfileTypeId": "string",
  "ContactName": "string",
  "ProfileName": "string",
  "Name": "string",
  "PaymentGatewayTypeId": "string",
  "ProfileRawData": "string",
  "IsReadOnly": "string",
  "Actions": "string"
}

OrgAccountFinancialInfoPaymentProfileEditModel: object

IsDeletable: boolean
IsHub: boolean
IsAddingCard: boolean
PaymentProfileId: integer
AuditId: integer
PaymentGatewayId: string
PaymentGatewayTypeId: integer
Name: string
TenantName: string
TenantId: integer
ContactId: integer
OrganizationContactId: string
ContactIdHash: string
OrganizationContactIdHash: string
ProfileKey: string
ClientKey: string
TokenId: string
CardType: string
CardLast4: string
IsCC: boolean
IsExistingCC: boolean
CanAddBankAccount: boolean
PaymentProfileTypeId: integer
Unverified: boolean
ManageDpmProfilesAction: string
CreditCardInfo: string
BankInfo: string
BankCountries: string
CountryCode: string
AccountId: string
CardExpMonth: string
CardExpYear: string
TwoCardExpYear: string
UpdateCardMessage: string
CannotUpdateCardMessage: string
VerificationAmountOne: string
VerificationAmountTwo: string
PaymentProfileAssociatedItems: string
ConfigInfoJson: string
Address: string
City: string
State: string
PostalCode: string
Currency: string
ContactName: string
IsTestCard: boolean
PayerName: string
Email: string
Country: string
CurrencyType: string
IsTestBank: boolean
IsSavingsAccount: boolean
PreferredEmailAddress: string
AccountLast4: string
BankName: string
CssClass: string
NarPaymentsBaseUrl: string
NRDSMemberId: string
ContactNRDSMemberId: string
DefaultNRDSMemberId: string
AccountNumber: string
RoutingNumber: string
AccountHolderType: string
FirstName: string
LastName: string
Example
{
  "IsDeletable": "boolean",
  "IsHub": "boolean",
  "IsAddingCard": "boolean",
  "PaymentProfileId": "integer",
  "AuditId": "integer",
  "PaymentGatewayId": "string",
  "PaymentGatewayTypeId": "integer",
  "Name": "string",
  "TenantName": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationContactId": "string",
  "ContactIdHash": "string",
  "OrganizationContactIdHash": "string",
  "ProfileKey": "string",
  "ClientKey": "string",
  "TokenId": "string",
  "CardType": "string",
  "CardLast4": "string",
  "IsCC": "boolean",
  "IsExistingCC": "boolean",
  "CanAddBankAccount": "boolean",
  "PaymentProfileTypeId": "integer",
  "Unverified": "boolean",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "BankInfo": "string",
  "BankCountries": "string",
  "CountryCode": "string",
  "AccountId": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "TwoCardExpYear": "string",
  "UpdateCardMessage": "string",
  "CannotUpdateCardMessage": "string",
  "VerificationAmountOne": "string",
  "VerificationAmountTwo": "string",
  "PaymentProfileAssociatedItems": "string",
  "ConfigInfoJson": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Currency": "string",
  "ContactName": "string",
  "IsTestCard": "boolean",
  "PayerName": "string",
  "Email": "string",
  "Country": "string",
  "CurrencyType": "string",
  "IsTestBank": "boolean",
  "IsSavingsAccount": "boolean",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "CssClass": "string",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "FirstName": "string",
  "LastName": "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"
}

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

AccountCertificationInfoViewModel: object

CertificationContactId: integer
Name: string
Status: string
CreditsEarned: string
CreditsRemaining: string
CompletedDate: string
Actions: string
Example
{
  "CertificationContactId": "integer",
  "Name": "string",
  "Status": "string",
  "CreditsEarned": "string",
  "CreditsRemaining": "string",
  "CompletedDate": "string",
  "Actions": "string"
}

CertificationSearchCatalogModel: object

CertificationTypeId: integer
Name: string
Description: string
CreditsRequired: string
HoursRequired: string
MemberPrice: string
Actions: string
IsApprovalRequired: boolean
IsInEnrollmentDateRange: boolean
EnrollmentStartDate: string
EnrollmentEndDate: string
Example
{
  "CertificationTypeId": "integer",
  "Name": "string",
  "Description": "string",
  "CreditsRequired": "string",
  "HoursRequired": "string",
  "MemberPrice": "string",
  "Actions": "string",
  "IsApprovalRequired": "boolean",
  "IsInEnrollmentDateRange": "boolean",
  "EnrollmentStartDate": "string",
  "EnrollmentEndDate": "string"
}

CertificationCatalogAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactId: integer
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "Criteria": "string"
}

ListViewReturnModel<CertificationActivityModel>: 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"
}

CertificationActivityAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactId: integer
ShowRelatedContacts: boolean
MyActivity: boolean
AllRelatedContactActivity: boolean
Courses: string
Type: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyActivity": "boolean",
  "AllRelatedContactActivity": "boolean",
  "Courses": "string",
  "Type": "string",
  "Criteria": "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"
}

ListViewReturnModel<CertificationCoursesModel>: 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"
}

CertificationCoursesAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactId: integer
ShowRelatedContacts: boolean
MyCourses: boolean
AllRelatedContactCourses: boolean
Courses: string
Type: string
Completed: boolean
NotCompletedSinceDate: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "ShowRelatedContacts": "boolean",
  "MyCourses": "boolean",
  "AllRelatedContactCourses": "boolean",
  "Courses": "string",
  "Type": "string",
  "Completed": "boolean",
  "NotCompletedSinceDate": "string",
  "Criteria": "string"
}

DirectoryAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
AllowCity: boolean
AllowPostal: boolean
AllowState: boolean
AllowCountry: boolean
AllowCategory: boolean
AllowCustomFields: boolean
Name: string
City: string
StateProvince_: string
PostalCode: string
Country: string
ListCategories: string
CustomFields: string
Criteria: string
DirectoryId: integer
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "AllowCity": "boolean",
  "AllowPostal": "boolean",
  "AllowState": "boolean",
  "AllowCountry": "boolean",
  "AllowCategory": "boolean",
  "AllowCustomFields": "boolean",
  "Name": "string",
  "City": "string",
  "StateProvince_": "string",
  "PostalCode": "string",
  "Country": "string",
  "ListCategories": "string",
  "CustomFields": "string",
  "Criteria": "string",
  "DirectoryId": "integer"
}

CategoryListValueFilterOptionsSelection: object

Id: integer
Name: string
Values: string
Selection: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "Values": "string",
  "Selection": "integer"
}

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"
}

CustomFieldValueFilterOptionsSelection: object

Id: integer
Name: string
Values: string
Selection: string
Example
{
  "Id": "integer",
  "Name": "string",
  "Values": "string",
  "Selection": "string"
}

ListViewReturnModel<DirectoryListItemModel>: 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"
}

DirectoryItemViewModel: object

DirectoryContactId: integer
ContactId: integer
Name: string
ContactType: string
DirectoryContactDescription: string
DirectoryContactOrganizations: string
DirectoryOrgContacts: string
DirectoryContactCategories: string
DirectoryContactMemberships: string
AdditionalInfo: string
ContactInfo: string
Images: string
Videos: string
ProfileImage: string
OrgProfileImage: string
Example
{
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "Name": "string",
  "ContactType": "string",
  "DirectoryContactDescription": "string",
  "DirectoryContactOrganizations": "string",
  "DirectoryOrgContacts": "string",
  "DirectoryContactCategories": "string",
  "DirectoryContactMemberships": "string",
  "AdditionalInfo": "string",
  "ContactInfo": "string",
  "Images": "string",
  "Videos": "string",
  "ProfileImage": "string",
  "OrgProfileImage": "string"
}

DirectoryContact: object

ObjectId: integer
MicroNet.MMP.Data.IContactActivity.Description: string
MicroNet.MMP.Data.IContactActivity.OverrideObjectIdWithUniqueValue: boolean
AuditSourceId: string
PrimaryKey: integer
DirectoryContactId: integer
IsDeleted: boolean
DirectoryId: integer
PublishStartDate: string
PublishEndDate: string
ContactId: integer
DisplayName: string
DirectoryListingTypeId: string
AuditId: integer
AddressId: string
EmailAddressId: string
PhoneId: string
WebAddressId: string
ParentDirectoryContactId: string
DisplayPrimaryContact: boolean
SettingsJson: string
MembershipId: string
DisplaySortValue: string
DirectoryContacts: string
DirectoryContactCustomFieldValues: string
DirectoryContactVideos: string
DirectoryListingUpgrades: string
SiteDirectoryAppearances: string
Address: string
AuditInfo: string
Contact: string
Directory: string
DirectoryContact_ParentDirectoryContactId: string
DirectoryListingType: string
EmailAddress: string
Membership: string
Phone: string
WebAddress: string
Example
{
  "ObjectId": "integer",
  "MicroNet.MMP.Data.IContactActivity.Description": "string",
  "MicroNet.MMP.Data.IContactActivity.OverrideObjectIdWithUniqueValue": "boolean",
  "AuditSourceId": "string",
  "PrimaryKey": "integer",
  "DirectoryContactId": "integer",
  "IsDeleted": "boolean",
  "DirectoryId": "integer",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "ContactId": "integer",
  "DisplayName": "string",
  "DirectoryListingTypeId": "string",
  "AuditId": "integer",
  "AddressId": "string",
  "EmailAddressId": "string",
  "PhoneId": "string",
  "WebAddressId": "string",
  "ParentDirectoryContactId": "string",
  "DisplayPrimaryContact": "boolean",
  "SettingsJson": "string",
  "MembershipId": "string",
  "DisplaySortValue": "string",
  "DirectoryContacts": "string",
  "DirectoryContactCustomFieldValues": "string",
  "DirectoryContactVideos": "string",
  "DirectoryListingUpgrades": "string",
  "SiteDirectoryAppearances": "string",
  "Address": "string",
  "AuditInfo": "string",
  "Contact": "string",
  "Directory": "string",
  "DirectoryContact_ParentDirectoryContactId": "string",
  "DirectoryListingType": "string",
  "EmailAddress": "string",
  "Membership": "string",
  "Phone": "string",
  "WebAddress": "string"
}

DirectoryItemBase: object

DirectoryId: integer
DirectoryContactId: integer
name: string
displayName: string
Name: string
Image: string
images: string
Visibility: string
Prefix: string
CommonName: string
FirstName: string
MiddleName: string
ContactCommonName: string
LastName: string
Suffix: string
OrgName: string
Example
{
  "DirectoryId": "integer",
  "DirectoryContactId": "integer",
  "name": "string",
  "displayName": "string",
  "Name": "string",
  "Image": "string",
  "images": "string",
  "Visibility": "string",
  "Prefix": "string",
  "CommonName": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "ContactCommonName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrgName": "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"
}

MyDirectoryListingsModel: object

ProfileImage: string
FamilyProfileImage: string
ContactId: integer
HideContactDropdown: boolean
Owner: string
owner: string
Title: string
TooltipMessage: string
SystemContactTypeId: string
ShowGallery: boolean
ShowVideo: boolean
ShowHighlights: boolean
DisableCategories: boolean
PersonContactInfo: string
DirectoryListings: string
DirectoryInfo: string
Categories: string
MembershipId: string
Images: string
Videos: string
IsReadOnly: boolean
visibilityJson: string
visibility: string
Visibility: string
DirectoryId: integer
DirectoryContactId: integer
ScreenActions: string
CssClass: string
CategoryTypeId: string
ErrorMessage: string
Example
{
  "ProfileImage": "string",
  "FamilyProfileImage": "string",
  "ContactId": "integer",
  "HideContactDropdown": "boolean",
  "Owner": "string",
  "owner": "string",
  "Title": "string",
  "TooltipMessage": "string",
  "SystemContactTypeId": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "DisableCategories": "boolean",
  "PersonContactInfo": "string",
  "DirectoryListings": "string",
  "DirectoryInfo": "string",
  "Categories": "string",
  "MembershipId": "string",
  "Images": "string",
  "Videos": "string",
  "IsReadOnly": "boolean",
  "visibilityJson": "string",
  "visibility": "string",
  "Visibility": "string",
  "DirectoryId": "integer",
  "DirectoryContactId": "integer",
  "ScreenActions": "string",
  "CssClass": "string",
  "CategoryTypeId": "string",
  "ErrorMessage": "string"
}

EditDirectoryContactInfoModel: object

ContactId: integer
AuditId: integer
ShortDescription: string
Description: string
Keywords: string
Highlights: string
Example
{
  "ContactId": "integer",
  "AuditId": "integer",
  "ShortDescription": "string",
  "Description": "string",
  "Keywords": "string",
  "Highlights": "string"
}

DirectoryListingChoiceItemModel: object

Id: integer
Name: string
ContactId: integer
Owner: string
ContactInfoAuditId: integer
ProfileImage: string
PersonContactInfo: string
DirectoryListings: string
DirectoryInfo: string
CssClass: string
Categories: string
Images: string
Videos: string
ShowGallery: boolean
ShowVideo: boolean
ShowHighlights: boolean
Visibility: string
ScreenActions: string
SystemContactTypeId: string
CategoryTypeId: string
Example
{
  "Id": "integer",
  "Name": "string",
  "ContactId": "integer",
  "Owner": "string",
  "ContactInfoAuditId": "integer",
  "ProfileImage": "string",
  "PersonContactInfo": "string",
  "DirectoryListings": "string",
  "DirectoryInfo": "string",
  "CssClass": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "Visibility": "string",
  "ScreenActions": "string",
  "SystemContactTypeId": "string",
  "CategoryTypeId": "string"
}

DirectoryCustomFieldsAddEditModel: object

DirectoryContactId: integer
ContactId: integer
DisplayName: string
DisplaySortValue: string
Fields: string
ShowCustomFields: string
Visibility: string
Example
{
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "DisplayName": "string",
  "DisplaySortValue": "string",
  "Fields": "string",
  "ShowCustomFields": "string",
  "Visibility": "string"
}

MyEventVouchersModel: object

ContactId: integer
Vouchers: string
Example
{
  "ContactId": "integer",
  "Vouchers": "string"
}

EventCollectionBaseModel: object

HasVouchers: boolean
Example
{
  "HasVouchers": "boolean"
}

ListViewReturnModel<EventListItemModel>: 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"
}

EventAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
CurrentContactId: integer
Categories: string
Calendar: string
StartDateBetween: string
IsMembersOnly: boolean
HasSponsorshipsAvailable: boolean
IsCurrentlyRegisteredIn: boolean
IsCurrentlySponsor: boolean
IsRegistrationOpen: boolean
EventsICreated: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "CurrentContactId": "integer",
  "Categories": "string",
  "Calendar": "string",
  "StartDateBetween": "string",
  "IsMembersOnly": "boolean",
  "HasSponsorshipsAvailable": "boolean",
  "IsCurrentlyRegisteredIn": "boolean",
  "IsCurrentlySponsor": "boolean",
  "IsRegistrationOpen": "boolean",
  "EventsICreated": "boolean",
  "Criteria": "string"
}

EventAddModel: object

EventId: integer
ContentStatusId: string
SyncWithGoToWebinar: boolean
SyncWithZoom: boolean
SyncWithLMS: boolean
Name: string
ContactId: string
Contact: string
OrganizationId: string
Organization: string
EmailAddressId: string
EmailAddressString: string
PhoneId: string
PhoneString: string
ContactDescription: string
Description: string
LocationName: string
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryId: string
PublishDate: string
StartDateTime: string
EndDateTime: string
IsAllDay: boolean
HoursDescription: string
CategoryItems: string
CalendarItems: string
EnableRegistration: boolean
EnableSessions: boolean
Example
{
  "EventId": "integer",
  "ContentStatusId": "string",
  "SyncWithGoToWebinar": "boolean",
  "SyncWithZoom": "boolean",
  "SyncWithLMS": "boolean",
  "Name": "string",
  "ContactId": "string",
  "Contact": "string",
  "OrganizationId": "string",
  "Organization": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDateTime": "string",
  "EndDateTime": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string",
  "EnableRegistration": "boolean",
  "EnableSessions": "boolean"
}

EventEditModel: object

EventId: integer
EventDetailId: integer
Name: string
ContactId: integer
ContactName: string
OrganizationId: string
OrganizationName: string
EmailAddressId: string
EmailAddressString: string
PhoneId: string
PhoneString: string
ContactDescription: string
Description: string
LocationName: string
AddressId: integer
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryId: string
PublishDate: string
StartDate: string
EndDate: string
IsAllDay: boolean
HoursDescription: string
CategoryItems: string
CalendarItems: string
Example
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Name": "string",
  "ContactId": "integer",
  "ContactName": "string",
  "OrganizationId": "string",
  "OrganizationName": "string",
  "EmailAddressId": "string",
  "EmailAddressString": "string",
  "PhoneId": "string",
  "PhoneString": "string",
  "ContactDescription": "string",
  "Description": "string",
  "LocationName": "string",
  "AddressId": "integer",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryId": "string",
  "PublishDate": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsAllDay": "boolean",
  "HoursDescription": "string",
  "CategoryItems": "string",
  "CalendarItems": "string"
}

EventListItemModel: object

EventId: integer
EventDetailId: integer
Status: string
EventName: string
StartDateLocal: string
StartDate: string
Description: string
PublicRegisterUrl: string
CalendarUrl: string
HidePublicRegistrationLink: boolean
HidePurchaseSponsorship: boolean
Actions: string
MaxAttendees: integer
MaxRegistrationSlots: integer
AttendeeCount: integer
EndDateLocal: string
EndDate: string
RegistrationStartDate: string
RegistrationEndDate: string
AllowWaitingList: boolean
IsAllDay: boolean
EnableRegistration: boolean
IsCurrentContactRegistered: boolean
RegistrationMode: string
ExternalRegistrationModeFlags: string
Example
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "Status": "string",
  "EventName": "string",
  "StartDateLocal": "string",
  "StartDate": "string",
  "Description": "string",
  "PublicRegisterUrl": "string",
  "CalendarUrl": "string",
  "HidePublicRegistrationLink": "boolean",
  "HidePurchaseSponsorship": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "EndDateLocal": "string",
  "EndDate": "string",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "IsAllDay": "boolean",
  "EnableRegistration": "boolean",
  "IsCurrentContactRegistered": "boolean",
  "RegistrationMode": "string",
  "ExternalRegistrationModeFlags": "string"
}

EventBaseModel: object

EventId: integer
Name: string
ContentStatusId: string
PublicRegisterUrl: string
HidePublicRegistrationLink: boolean
Actions: string
MaxAttendees: integer
MaxRegistrationSlots: integer
AttendeeCount: integer
RegistrationStartDate: string
RegistrationEndDate: string
AllowWaitingList: boolean
EnableRegistration: boolean
StartDate: string
EndDate: string
RegistrationUpdateUrl: string
RegistrationMode: string
ExternalRegistrationModeFlags: string
Example
{
  "EventId": "integer",
  "Name": "string",
  "ContentStatusId": "string",
  "PublicRegisterUrl": "string",
  "HidePublicRegistrationLink": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "EnableRegistration": "boolean",
  "StartDate": "string",
  "EndDate": "string",
  "RegistrationUpdateUrl": "string",
  "RegistrationMode": "string",
  "ExternalRegistrationModeFlags": "string"
}

CertificationRegistrationModel: object

TenantId: integer
TenantName: string
ShowWithoutPaymentGateway: boolean
OpenInvoices: string
InvoicePaymentSelection: string
IncludeRelatedContactsInvoices: boolean
ContactId: string
PurchasedByContactId: string
SystemContactTypeId: string
PaymentContactId: string
OrganizationId: string
SaveOnContactId: string
SaveOnOrganizationId: string
PaymentId: integer

Not sure we will use this - probably delete later

AuthProfilePageToken: string
AuthProfileUrl: string
ShowGateways: boolean
ReadOnlyGateways: boolean
GatewayAccountId: string
ContactName: string
PaymentProfileId: string
ManageDpmProfilesAction: string
PaymentGatewayId: string
ConfigInfoJson: string
PaymentGatewayTypeId: string
GatewayErrorMessage: string
GatewayErrorCleared: string
CreditCardInfo: string
CheckNumber: string
StorePaymentInfoForFuture: boolean
PayByNewCard: boolean
TokenId: string
Capture: string
SimResponse: string
EPaymentTransactionId: integer
DataDescriptor: string
DataValue: string
IsTestCard: boolean
CardType: string
CardLast4: string
CardExpMonth: string
CardExpYear: string
CardCvc: string
PaymentDate: string
Amount: number
UseDefaultNrdsIdOverride: boolean
VoluntaryAmount: number
Currency: string
GatewayAmounts: string
IsBankCharge: boolean
IsSavingsAccount: boolean
IsTestBank: boolean
CurrencyType: string
Country: string
PayerName: string
PreferredEmailAddress: string
AccountLast4: string
BankName: string
AccountNumber: string
RoutingNumber: string
AccountHolderType: string
PurchaseId: integer

Optional parameter in case we are filtering to pay for a single invoice

TxnContactId: integer

Optional parameter in case we are filtering to pay for a single invoice

PaymentUsesGateway: boolean
InitialModelLoaded: boolean
ScheduledBillingItems: string
Company: string
FirstName: string
LastName: string
Address: string
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryCode: string
Email: string
Phone: string
HttpReferer: string
ClientSideMethod: string
ResponseData: string
FailureReason: string
forceSave: boolean
NarPaymentsBaseUrl: string
NRDSMemberId: string
ContactNRDSMemberId: string
DefaultNRDSMemberId: string
HasNRDSMemberId: string
CardAccountType: string
NarSplitsInfo: string
CanAddPaymentProfile: boolean
SaleableItemAmounts: string
AssociationRequestId: string
AllowPartialPayments: boolean
CssClass: string
ShowEmailPaymentReceipt: boolean
IsStaffOrAdmin: boolean
EmailPaymentReceipt: boolean
PaymentTerms: string
PaymentSourceInfo: string
SourceInfo: string
HasRequiredLateFee: boolean
RecaptchaToken: string
CertificationTypeId: integer
CertificationContactId: integer
Title: string
RegistrationType: string
IsApprovalRequired: boolean
CertificationTypeName: string
ShowMessage: boolean
HideButtons: boolean
HidePaymentWidget: boolean
HideApplyButton: boolean
HideEnrollButton: boolean
HideFreeApplyButton: boolean
HideFreeEnrollButton: boolean
IsFree: boolean
RegistrationResult: string
ContactInfo: string
TermsAndConditions: string
InvoiceMe: boolean
CanStoreProfile: boolean
AllowInvoicing: boolean
Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationTypeId": "integer",
  "CertificationContactId": "integer",
  "Title": "string",
  "RegistrationType": "string",
  "IsApprovalRequired": "boolean",
  "CertificationTypeName": "string",
  "ShowMessage": "boolean",
  "HideButtons": "boolean",
  "HidePaymentWidget": "boolean",
  "HideApplyButton": "boolean",
  "HideEnrollButton": "boolean",
  "HideFreeApplyButton": "boolean",
  "HideFreeEnrollButton": "boolean",
  "IsFree": "boolean",
  "RegistrationResult": "string",
  "ContactInfo": "string",
  "TermsAndConditions": "string",
  "InvoiceMe": "boolean",
  "CanStoreProfile": "boolean",
  "AllowInvoicing": "boolean"
}

EventDetailModel: object

EventId: integer
EventDetailId: integer
EventLogoImage: string
Name: string
EventDescription: string
EventHours: string
HourDescription: string
Sessions: string
Pricing: string
Location: string
EventCertificationComponents: string
ContactInfo: string
Images: string
ShowImageGallery: boolean
Videos: string
EventBasicDetails: string
EventSponsorDetails: string
EventRegistrationSummary: string
EventSponsorSummary: string
Attendees: string
PublicRegisterUrl: string
UpdateRegisterUrl: string
ChangeStatusUrl: string
PublicSponsorRegistrationUrl: string
PublicExhibitorRegistrationUrl: string
ShowPublicRegistrationLink: boolean
Actions: string
MaxAttendees: integer
RegistrationSlots: string
MaxRegistrationSlots: integer
AttendeeCount: integer
RegistrationStartDate: string
RegistrationEndDate: string
AllowWaitingList: boolean
EnableRegistration: boolean
StartDate: string
EndDate: string
ShowRegisteredAttendeesToMembers: boolean
IsCurrentContactRegistered: boolean
EventRegistrationId: string
EventAttendeeId: string
CanEdit: boolean
CreatedBy: integer
ContactId: integer
HasSessions: boolean
EnableSessions: boolean
EventSessionSetupItemCollection: string
EventSponsorListItemViewModel: string
EventRegistrationExtraOptionsJson: string
DisplayNumberOfRegistrants: boolean
RegistrationMode: string
SponsorshipRegistrationReqs: string
ExhibitorRegistrationReqs: string
Example
{
  "EventId": "integer",
  "EventDetailId": "integer",
  "EventLogoImage": "string",
  "Name": "string",
  "EventDescription": "string",
  "EventHours": "string",
  "HourDescription": "string",
  "Sessions": "string",
  "Pricing": "string",
  "Location": "string",
  "EventCertificationComponents": "string",
  "ContactInfo": "string",
  "Images": "string",
  "ShowImageGallery": "boolean",
  "Videos": "string",
  "EventBasicDetails": "string",
  "EventSponsorDetails": "string",
  "EventRegistrationSummary": "string",
  "EventSponsorSummary": "string",
  "Attendees": "string",
  "PublicRegisterUrl": "string",
  "UpdateRegisterUrl": "string",
  "ChangeStatusUrl": "string",
  "PublicSponsorRegistrationUrl": "string",
  "PublicExhibitorRegistrationUrl": "string",
  "ShowPublicRegistrationLink": "boolean",
  "Actions": "string",
  "MaxAttendees": "integer",
  "RegistrationSlots": "string",
  "MaxRegistrationSlots": "integer",
  "AttendeeCount": "integer",
  "RegistrationStartDate": "string",
  "RegistrationEndDate": "string",
  "AllowWaitingList": "boolean",
  "EnableRegistration": "boolean",
  "StartDate": "string",
  "EndDate": "string",
  "ShowRegisteredAttendeesToMembers": "boolean",
  "IsCurrentContactRegistered": "boolean",
  "EventRegistrationId": "string",
  "EventAttendeeId": "string",
  "CanEdit": "boolean",
  "CreatedBy": "integer",
  "ContactId": "integer",
  "HasSessions": "boolean",
  "EnableSessions": "boolean",
  "EventSessionSetupItemCollection": "string",
  "EventSponsorListItemViewModel": "string",
  "EventRegistrationExtraOptionsJson": "string",
  "DisplayNumberOfRegistrants": "boolean",
  "RegistrationMode": "string",
  "SponsorshipRegistrationReqs": "string",
  "ExhibitorRegistrationReqs": "string"
}

EventSessionsModel: object

EventId: integer
EventSessionsInfo: string
Example
{
  "EventId": "integer",
  "EventSessionsInfo": "string"
}

ListViewReturnModel<ResourceListItemModel>: 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"
}

ResourceAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
FolderId: string
Groups: string
Category: string
ResourceType: string
DateAdded: string
Criteria: string
WebDavServerUrl: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "FolderId": "string",
  "Groups": "string",
  "Category": "string",
  "ResourceType": "string",
  "DateAdded": "string",
  "Criteria": "string",
  "WebDavServerUrl": "string"
}

ResourceAddEditModel: object

ResourceId: integer
AuditId: integer
ResourceTypeId: string
Title: string
Summary: string
File: string
Url: string
VideoUrl: string
GroupPermissions: string
PublishStartDate: string
PublishEndDate: string
FileId: string
Categories: string
FolderId: string
SystemFolderTypeId: string
Tags: string
ContentType: string
Example
{
  "ResourceId": "integer",
  "AuditId": "integer",
  "ResourceTypeId": "string",
  "Title": "string",
  "Summary": "string",
  "File": "string",
  "Url": "string",
  "VideoUrl": "string",
  "GroupPermissions": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "FileId": "string",
  "Categories": "string",
  "FolderId": "string",
  "SystemFolderTypeId": "string",
  "Tags": "string",
  "ContentType": "string"
}

ResourceDetailModel: object

ResourceId: integer
ResourceTypeId: string
Title: string
CleanTitle: string
CreatedBy: string
CreatedByText: string
CreatedById: integer
DateAdded: string
DateAddedString: string
Summary: string
FileName: string
File: string
FileUrl: string
DownloadAction: string
ResourceUrl: string
Image: string
AbsoluteUrl: string
GoToLinkAction: string
Url: string
Video: string
FileId: string
ResourceCategories: string
ResourceGroups: string
ContentType: string
HideEdit: boolean
HasAccess: boolean
Example
{
  "ResourceId": "integer",
  "ResourceTypeId": "string",
  "Title": "string",
  "CleanTitle": "string",
  "CreatedBy": "string",
  "CreatedByText": "string",
  "CreatedById": "integer",
  "DateAdded": "string",
  "DateAddedString": "string",
  "Summary": "string",
  "FileName": "string",
  "File": "string",
  "FileUrl": "string",
  "DownloadAction": "string",
  "ResourceUrl": "string",
  "Image": "string",
  "AbsoluteUrl": "string",
  "GoToLinkAction": "string",
  "Url": "string",
  "Video": "string",
  "FileId": "string",
  "ResourceCategories": "string",
  "ResourceGroups": "string",
  "ContentType": "string",
  "HideEdit": "boolean",
  "HasAccess": "boolean"
}

ResourceListItemModel: object

ResourceId: string
Type: string
Title: string
CleanTitle: string
ResourceCategories: string
Summary: string
ResourceCategoriesCard: string
ResourceGroups: string
DateAdded: string
ResourceTypeId: string
FileId: string
ContentType: string
VerifiedContentType: string
Url: string
AuditId: string
AbsoluteUrl: string
HubIconCssClass: string
ImageUrl: string
UseHubClass: boolean
Actions: string
CanEdit: boolean
CanDelete: boolean
CreatedBy: string
ResourceUrl: string
IsBackOfficeList: boolean
FolderId: string
Example
{
  "ResourceId": "string",
  "Type": "string",
  "Title": "string",
  "CleanTitle": "string",
  "ResourceCategories": "string",
  "Summary": "string",
  "ResourceCategoriesCard": "string",
  "ResourceGroups": "string",
  "DateAdded": "string",
  "ResourceTypeId": "string",
  "FileId": "string",
  "ContentType": "string",
  "VerifiedContentType": "string",
  "Url": "string",
  "AuditId": "string",
  "AbsoluteUrl": "string",
  "HubIconCssClass": "string",
  "ImageUrl": "string",
  "UseHubClass": "boolean",
  "Actions": "string",
  "CanEdit": "boolean",
  "CanDelete": "boolean",
  "CreatedBy": "string",
  "ResourceUrl": "string",
  "IsBackOfficeList": "boolean",
  "FolderId": "string"
}

ContactFilesViewModel: object

FolderId: string
FolderPath: string
PathList: string
PersonFilesUpload: string
TenantFiles: string
ContactId: integer
Example
{
  "FolderId": "string",
  "FolderPath": "string",
  "PathList": "string",
  "PersonFilesUpload": "string",
  "TenantFiles": "string",
  "ContactId": "integer"
}

FileModel: object

Type: string
Name: string
LastModifiedDate: string
CloudFileProviderId: string
LastModifiedBy: string
SizeInBytes: integer
ContentType: string
Url: string
Id: integer
IsPublic: boolean
IsShared: boolean
FolderId: string
FileId: string
EditUrl: string
IsError: boolean
Exception: string
IsSystem: boolean
ContactId: string
IsReadOnly: boolean
FileHash: string
DisableShare: boolean
DisableOpen: boolean
Example
{
  "Type": "string",
  "Name": "string",
  "LastModifiedDate": "string",
  "CloudFileProviderId": "string",
  "LastModifiedBy": "string",
  "SizeInBytes": "integer",
  "ContentType": "string",
  "Url": "string",
  "Id": "integer",
  "IsPublic": "boolean",
  "IsShared": "boolean",
  "FolderId": "string",
  "FileId": "string",
  "EditUrl": "string",
  "IsError": "boolean",
  "Exception": "string",
  "IsSystem": "boolean",
  "ContactId": "string",
  "IsReadOnly": "boolean",
  "FileHash": "string",
  "DisableShare": "boolean",
  "DisableOpen": "boolean"
}

ContentListListItemModel: object

ContentListId: integer
ContentTypeId: string
Name: string
Description: string
Example
{
  "ContentListId": "integer",
  "ContentTypeId": "string",
  "Name": "string",
  "Description": "string"
}

ListViewReturnModel<ContentItemListItemModel, ContentItemManagementModel>: 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"
}

ContentItemAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContentListId: integer
ContentStatusId: string
CategoryId: string
PublishStartDateBetween: string
ContentCreatedByMe: boolean
IsCurrent: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContentListId": "integer",
  "ContentStatusId": "string",
  "CategoryId": "string",
  "PublishStartDateBetween": "string",
  "ContentCreatedByMe": "boolean",
  "IsCurrent": "boolean",
  "Criteria": "string"
}

ContentItemViewModel: object

ContentItemId: integer
ContentListId: integer
ContentTitle: string
ShortDescription: string
ContactNameLink: string
ContactName: string
ContentStatusId: string
ContentStatus: string
ContentDate: string
PublishContentDate: string
PublishEnd: string
Description: string
ContentCategories: string
Images: string
ContentAdditionInfoCustomFields: string
CustomFields: string
ShowAdditionalFields: boolean
ContactId: integer
CurrentUserContactId: integer
SearchImageUrl: string
SearchImageShortDescription: string
FileImageInfoId: integer
DirectoryContactId: string
CreatedBy: integer
HideEdit: boolean
Example
{
  "ContentItemId": "integer",
  "ContentListId": "integer",
  "ContentTitle": "string",
  "ShortDescription": "string",
  "ContactNameLink": "string",
  "ContactName": "string",
  "ContentStatusId": "string",
  "ContentStatus": "string",
  "ContentDate": "string",
  "PublishContentDate": "string",
  "PublishEnd": "string",
  "Description": "string",
  "ContentCategories": "string",
  "Images": "string",
  "ContentAdditionInfoCustomFields": "string",
  "CustomFields": "string",
  "ShowAdditionalFields": "boolean",
  "ContactId": "integer",
  "CurrentUserContactId": "integer",
  "SearchImageUrl": "string",
  "SearchImageShortDescription": "string",
  "FileImageInfoId": "integer",
  "DirectoryContactId": "string",
  "CreatedBy": "integer",
  "HideEdit": "boolean"
}

ContentItemEditModel: object

ContentItemId: integer
AuditId: integer
ContentListId: integer
EditKey: string
PricingOptionId: string
CanChangePublishDates: boolean
ContactId: integer
PublishedByContactId: string
ContentStatusId: string
Title: string
Tags: string
Description: string
PublishStart: string
PublishEnd: string
ShortDescription: string
CategoryItems: string
Fields: string
SearchItemImage: string
Images: string
Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "EditKey": "string",
  "PricingOptionId": "string",
  "CanChangePublishDates": "boolean",
  "ContactId": "integer",
  "PublishedByContactId": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Tags": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "ShortDescription": "string",
  "CategoryItems": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string"
}

ContentItemListItemModel: object

ContentListId: integer
ContentItemId: integer
AuditId: integer
CreatedBy: integer
ModifiedBy: integer
Title: string
ShortDescription: string
ContactName: string
ContactId: integer
ContentStatusId: string
PublishStart: string
ContentDate: string
CanEdit: boolean
HideCancel: boolean
SearchImageUrl: string
SearchImageShortDescription: string
ContentCategoryItems: string
ContentListImageUrl: string
ContentListImageShortDescription: string
HubIconCssClass: string
DefaultImageUrl: string
DefaultImageShortDescription: string
UseHubClass: boolean
Actions: string
Example
{
  "ContentListId": "integer",
  "ContentItemId": "integer",
  "AuditId": "integer",
  "CreatedBy": "integer",
  "ModifiedBy": "integer",
  "Title": "string",
  "ShortDescription": "string",
  "ContactName": "string",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStart": "string",
  "ContentDate": "string",
  "CanEdit": "boolean",
  "HideCancel": "boolean",
  "SearchImageUrl": "string",
  "SearchImageShortDescription": "string",
  "ContentCategoryItems": "string",
  "ContentListImageUrl": "string",
  "ContentListImageShortDescription": "string",
  "HubIconCssClass": "string",
  "DefaultImageUrl": "string",
  "DefaultImageShortDescription": "string",
  "UseHubClass": "boolean",
  "Actions": "string"
}

MyDownloadsModel: object

ContactId: integer
Downloads: string
Example
{
  "ContactId": "integer",
  "Downloads": "string"
}

MySubscriptionListItemModel: object

ContactId: integer
IsForumEnabled: boolean
DisallowAddEmailAddress: boolean
EmailSubscriptionDesc: string
EmailAddressId: string
Subscriptions: string
Example
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string"
}

CommunicationPreferencesViewModel: object

ContactId: integer
IsForumEnabled: boolean
IsEmailForumEnabled: boolean
ShowInvoiceDeliveryMethod: boolean
InvoiceDeliveryMethodDesc: string
InvoiceDeliveryMethod: string
DisallowAddEmailAddress: boolean
EmailSubscriptionDesc: string
EmailAddressId: string
Subscriptions: string
ForumNotificationDesc: string
ForumSubscriptionFrequencyOptionId: string
ForumWatchTypeId: string
ForumTopicWatchTypeId: string
ForumPreferences: string
Example
{
  "ContactId": "integer",
  "IsForumEnabled": "boolean",
  "IsEmailForumEnabled": "boolean",
  "ShowInvoiceDeliveryMethod": "boolean",
  "InvoiceDeliveryMethodDesc": "string",
  "InvoiceDeliveryMethod": "string",
  "DisallowAddEmailAddress": "boolean",
  "EmailSubscriptionDesc": "string",
  "EmailAddressId": "string",
  "Subscriptions": "string",
  "ForumNotificationDesc": "string",
  "ForumSubscriptionFrequencyOptionId": "string",
  "ForumWatchTypeId": "string",
  "ForumTopicWatchTypeId": "string",
  "ForumPreferences": "string"
}

SubscriptionListMembersModel: object

GroupId: integer
Name: string
Members: string
Example
{
  "GroupId": "integer",
  "Name": "string",
  "Members": "string"
}

CertificationBaseModel: object

Example
"object"

CertificationOverviewModel: object

CertificationEvents: string
Certifications: string
ContactActivities: string
Example
{
  "CertificationEvents": "string",
  "Certifications": "string",
  "ContactActivities": "string"
}

CertificationContactActivitiesItemModel: object

CertificationActivityId: integer
Caption: string
CertificationComponentId: string
CertificationContactId: integer
Certification: string
ComponentName: string
PurchaseId: string
PaymentId: string
SaleableItemId: string
ActivityDate: string
Description: string
Actions: string
HideReceiptButton: boolean
HidePayFeeButton: boolean
ApprovedByContactId: string
Example
{
  "CertificationActivityId": "integer",
  "Caption": "string",
  "CertificationComponentId": "string",
  "CertificationContactId": "integer",
  "Certification": "string",
  "ComponentName": "string",
  "PurchaseId": "string",
  "PaymentId": "string",
  "SaleableItemId": "string",
  "ActivityDate": "string",
  "Description": "string",
  "Actions": "string",
  "HideReceiptButton": "boolean",
  "HidePayFeeButton": "boolean",
  "ApprovedByContactId": "string"
}

CertificationContactItemModel: object

CertificationContactId: integer
Certification: string
SystemCertificationStatusId: string
CertificationStartDate: string
CompletedDate: string
HoursEarned: number
CreditsEarned: number
Percentage: string
PercentComplete: string
ExpirationDate: string
CertificationDocumentTemplateId: string
HasCertificationTemplate: boolean
HideDownloadCertificationButton: boolean
HideDownloadCertificationComponentButton: boolean
ShouldTrackCertificateCompletion: boolean
ExtraOptions: string
SettingJson: string
Actions: string
Example
{
  "CertificationContactId": "integer",
  "Certification": "string",
  "SystemCertificationStatusId": "string",
  "CertificationStartDate": "string",
  "CompletedDate": "string",
  "HoursEarned": "number",
  "CreditsEarned": "number",
  "Percentage": "string",
  "PercentComplete": "string",
  "ExpirationDate": "string",
  "CertificationDocumentTemplateId": "string",
  "HasCertificationTemplate": "boolean",
  "HideDownloadCertificationButton": "boolean",
  "HideDownloadCertificationComponentButton": "boolean",
  "ShouldTrackCertificateCompletion": "boolean",
  "ExtraOptions": "string",
  "SettingJson": "string",
  "Actions": "string"
}

ODataQueryOptions<CertificationContactItemModel>: object

Example
"object"

CertificationTypeDetailsModel: object

CertificationTypeId: integer
ContactId: integer
CertificationContactId: integer
Name: string
Description: string
IsApprovalRequired: boolean
DetailedCertificationTypeModel: string
IsInEnrollmentDateRange: boolean
CertificationTypeObjectives: string
Documents: string
Example
{
  "CertificationTypeId": "integer",
  "ContactId": "integer",
  "CertificationContactId": "integer",
  "Name": "string",
  "Description": "string",
  "IsApprovalRequired": "boolean",
  "DetailedCertificationTypeModel": "string",
  "IsInEnrollmentDateRange": "boolean",
  "CertificationTypeObjectives": "string",
  "Documents": "string"
}

CertificationHubProgressTracker: object

CertificationContactId: integer
CertificationName: string
Items: string
Example
{
  "CertificationContactId": "integer",
  "CertificationName": "string",
  "Items": "string"
}

CertificationComponentDownloadsModel: object

CertificationContactId: integer
Files: string
Example
{
  "CertificationContactId": "integer",
  "Files": "string"
}

SwapClaimsModel: object

CurrentUserContactId: integer
ContactId: integer
Example
{
  "CurrentUserContactId": "integer",
  "ContactId": "integer"
}

CertificationComponentDetails: object

CertificationComponentId: integer
Type: string
CertificationContactId: integer
CertificationComponentTypeId: string
Code: string
Name: string
Description: string
FeeName: string
FeePrice: string
Objectives: string
Documents: string
ComponentCertificates: string
ShowComponentCertificates: boolean
Example
{
  "CertificationComponentId": "integer",
  "Type": "string",
  "CertificationContactId": "integer",
  "CertificationComponentTypeId": "string",
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "FeeName": "string",
  "FeePrice": "string",
  "Objectives": "string",
  "Documents": "string",
  "ComponentCertificates": "string",
  "ShowComponentCertificates": "boolean"
}

CertificationComponentFeePayment: object

TenantId: integer
TenantName: string
ShowWithoutPaymentGateway: boolean
OpenInvoices: string
InvoicePaymentSelection: string
IncludeRelatedContactsInvoices: boolean
ContactId: string
PurchasedByContactId: string
SystemContactTypeId: string
PaymentContactId: string
OrganizationId: string
SaveOnContactId: string
SaveOnOrganizationId: string
PaymentId: integer

Not sure we will use this - probably delete later

AuthProfilePageToken: string
AuthProfileUrl: string
ShowGateways: boolean
ReadOnlyGateways: boolean
GatewayAccountId: string
ContactName: string
PaymentProfileId: string
ManageDpmProfilesAction: string
PaymentGatewayId: string
ConfigInfoJson: string
PaymentGatewayTypeId: string
GatewayErrorMessage: string
GatewayErrorCleared: string
CreditCardInfo: string
CheckNumber: string
StorePaymentInfoForFuture: boolean
PayByNewCard: boolean
TokenId: string
Capture: string
SimResponse: string
EPaymentTransactionId: integer
DataDescriptor: string
DataValue: string
IsTestCard: boolean
CardType: string
CardLast4: string
CardExpMonth: string
CardExpYear: string
CardCvc: string
PaymentDate: string
Amount: number
UseDefaultNrdsIdOverride: boolean
VoluntaryAmount: number
Currency: string
GatewayAmounts: string
IsBankCharge: boolean
IsSavingsAccount: boolean
IsTestBank: boolean
CurrencyType: string
Country: string
PayerName: string
PreferredEmailAddress: string
AccountLast4: string
BankName: string
AccountNumber: string
RoutingNumber: string
AccountHolderType: string
PurchaseId: integer

Optional parameter in case we are filtering to pay for a single invoice

TxnContactId: integer

Optional parameter in case we are filtering to pay for a single invoice

PaymentUsesGateway: boolean
InitialModelLoaded: boolean
ScheduledBillingItems: string
Company: string
FirstName: string
LastName: string
Address: string
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryCode: string
Email: string
Phone: string
HttpReferer: string
ClientSideMethod: string
ResponseData: string
FailureReason: string
forceSave: boolean
NarPaymentsBaseUrl: string
NRDSMemberId: string
ContactNRDSMemberId: string
DefaultNRDSMemberId: string
HasNRDSMemberId: string
CardAccountType: string
NarSplitsInfo: string
CanAddPaymentProfile: boolean
SaleableItemAmounts: string
AssociationRequestId: string
AllowPartialPayments: boolean
CssClass: string
ShowEmailPaymentReceipt: boolean
IsStaffOrAdmin: boolean
EmailPaymentReceipt: boolean
PaymentTerms: string
PaymentSourceInfo: string
SourceInfo: string
HasRequiredLateFee: boolean
RecaptchaToken: string
CertificationComponentId: integer
CertificationActivityId: integer
CertificationContactId: integer
CertificationTypeComponentId: integer
SaleableItemId: string
FeeDescription: string
CertificationComponentTypeId: string
Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "ShowWithoutPaymentGateway": "boolean",
  "OpenInvoices": "string",
  "InvoicePaymentSelection": "string",
  "IncludeRelatedContactsInvoices": "boolean",
  "ContactId": "string",
  "PurchasedByContactId": "string",
  "SystemContactTypeId": "string",
  "PaymentContactId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "PaymentId": "integer",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "ShowGateways": "boolean",
  "ReadOnlyGateways": "boolean",
  "GatewayAccountId": "string",
  "ContactName": "string",
  "PaymentProfileId": "string",
  "ManageDpmProfilesAction": "string",
  "PaymentGatewayId": "string",
  "ConfigInfoJson": "string",
  "PaymentGatewayTypeId": "string",
  "GatewayErrorMessage": "string",
  "GatewayErrorCleared": "string",
  "CreditCardInfo": "string",
  "CheckNumber": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PayByNewCard": "boolean",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "PaymentDate": "string",
  "Amount": "number",
  "UseDefaultNrdsIdOverride": "boolean",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "PurchaseId": "integer",
  "TxnContactId": "integer",
  "PaymentUsesGateway": "boolean",
  "InitialModelLoaded": "boolean",
  "ScheduledBillingItems": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "forceSave": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "CssClass": "string",
  "ShowEmailPaymentReceipt": "boolean",
  "IsStaffOrAdmin": "boolean",
  "EmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PaymentSourceInfo": "string",
  "SourceInfo": "string",
  "HasRequiredLateFee": "boolean",
  "RecaptchaToken": "string",
  "CertificationComponentId": "integer",
  "CertificationActivityId": "integer",
  "CertificationContactId": "integer",
  "CertificationTypeComponentId": "integer",
  "SaleableItemId": "string",
  "FeeDescription": "string",
  "CertificationComponentTypeId": "string"
}

MemberForumHomeScreenViewModel: object

ForumTopicList: string
ForumTree: string
FiteredByMenuTitle: string
FiteredByMenuDescription: string
ForumId: integer
AllMyWatching: boolean
AllMyPost: boolean
AllMyDrafts: boolean
IsForumScreen: boolean
Actions: string
Example
{
  "ForumTopicList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string",
  "FiteredByMenuDescription": "string",
  "ForumId": "integer",
  "AllMyWatching": "boolean",
  "AllMyPost": "boolean",
  "AllMyDrafts": "boolean",
  "IsForumScreen": "boolean",
  "Actions": "string"
}

ForumTopicsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
MyWatch: boolean
MyPost: boolean
MyDraft: boolean
DirectMessages: boolean
ForumId: string
CategoryId: string
PostedBy: string
PostedDateBetween: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "DirectMessages": "boolean",
  "ForumId": "string",
  "CategoryId": "string",
  "PostedBy": "string",
  "PostedDateBetween": "string",
  "Criteria": "string"
}

ForumTopicAddEditModel: object

ForumTopicId: integer
Title: string
ForumId: integer
Body: string
File: string
Publish: boolean
PostedByContactId: integer
Example
{
  "ForumTopicId": "integer",
  "Title": "string",
  "ForumId": "integer",
  "Body": "string",
  "File": "string",
  "Publish": "boolean",
  "PostedByContactId": "integer"
}

ForumTopicScreenViewModel: object

ForumTopic: string
TopicMessageList: string
ForumTree: string
ForumTopicId: integer
ForumId: integer
Example
{
  "ForumTopic": "string",
  "TopicMessageList": "string",
  "ForumTree": "string",
  "ForumTopicId": "integer",
  "ForumId": "integer"
}

ForumMessageReplyAddEditModel: object

ForumMessageId: integer
ForumTopicId: integer
IsReply: boolean
ParentForumMessageId: string
ContactId: integer
IsDraft: boolean
Body: string
File: string
ReplyHeading: string
Example
{
  "ForumMessageId": "integer",
  "ForumTopicId": "integer",
  "IsReply": "boolean",
  "ParentForumMessageId": "string",
  "ContactId": "integer",
  "IsDraft": "boolean",
  "Body": "string",
  "File": "string",
  "ReplyHeading": "string"
}

ForumMessageAddEditModel: object

ForumMessageId: integer
ForumTopicId: integer
IsReply: boolean
ParentForumMessageId: string
ContactId: integer
IsDraft: boolean
Body: string
File: string
Example
{
  "ForumMessageId": "integer",
  "ForumTopicId": "integer",
  "IsReply": "boolean",
  "ParentForumMessageId": "string",
  "ContactId": "integer",
  "IsDraft": "boolean",
  "Body": "string",
  "File": "string"
}

ForumCategoryScreenViewModel: object

CategoryId: integer
ForumList: string
ForumTree: string
FiteredByMenuTitle: string
Example
{
  "CategoryId": "integer",
  "ForumList": "string",
  "ForumTree": "string",
  "FiteredByMenuTitle": "string"
}

ForumCategoryAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
MyWatch: boolean
MyPost: boolean
MyDraft: boolean
CategoryId: integer
CustomSortBy: string
ActivityDateBetween: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "MyWatch": "boolean",
  "MyPost": "boolean",
  "MyDraft": "boolean",
  "CategoryId": "integer",
  "CustomSortBy": "string",
  "ActivityDateBetween": "string",
  "Criteria": "string"
}

ForumTermsViewModel: object

Terms: string
Example
{
  "Terms": "string"
}

PublicContactTypeAheadItem: object

Id: integer
Name: string
ContactId: integer
Contact: string
Example
{
  "Id": "integer",
  "Name": "string",
  "ContactId": "integer",
  "Contact": "string"
}

PublicOrganizationTypeAheadItem: object

Id: integer
Name: string
OrganizationId: integer
Organization: string
Example
{
  "Id": "integer",
  "Name": "string",
  "OrganizationId": "integer",
  "Organization": "string"
}

ResourceBaseViewModel: object

DisableFileSharing: boolean
Example
{
  "DisableFileSharing": "boolean"
}

EditScheduledPaymentProfileModel: object

PurchaseId: integer
PaymentProfileId: string
Example
{
  "PurchaseId": "integer",
  "PaymentProfileId": "string"
}

ListViewReturnModel<BillingHistoryListViewModel>: 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"
}

MyBillingHistoryAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactId: integer
OrganizationId: integer
ShowRelatedContacts: boolean
TransactiontDateBetween: string
TransactionTypeId: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "OrganizationId": "integer",
  "ShowRelatedContacts": "boolean",
  "TransactiontDateBetween": "string",
  "TransactionTypeId": "string",
  "Criteria": "string"
}