API Resources
Profile
| API | Description |
|---|---|
| GET Profile/{id} |
No documentation available. |
| GET profile/{id}/limited |
No documentation available. |
| GET profile/{id}/extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
No documentation available. |
| GET Profile/{id}/entityList |
No documentation available. |
| GET profile/{profileId}/MainOrFirstRelatedOrg |
for the given profile id: get the main related org or first primarily related org profile |
| GET profile/{id}/MainInd/Extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
Returns extended Profile information including primary related profiles and affiliation codes for the Main Individual of the given profileid. It can optionally include ALL related profiles, listings and/or web content data by setting the appropriate values on the optional parameter; |
| GET profile/{id}/MainContact/Extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
Returns extended Profile information including primary related profiles and affiliation codes for the Main Contact of the given profileid. The Main Contact is generally an organization if you pass an individual profileid and it is generally an individual if you pass an organization profileid. It can optionally include ALL related profiles, listings and/or web content data by setting the appropriate values on the optional parameter; |
| GET profile/{id}/relatedprofiles/extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
No documentation available. |
| GET profile/{id}/relatedprofiles/min |
Returns an object containing the profile and related profiles of the target profile id. |
| GET Profile/{id}/Entities |
get entities to which a profile belongs |
| GET Profiles |
No documentation available. |
| POST Profiles |
No documentation available. |
| POST Profile |
No documentation available. |
| PUT Profile/{id} |
No documentation available. |
| DELETE Profile/{id} |
No documentation available. |
| GET Profiles/{id}/RelatedProfiles |
No documentation available. |
| GET Profiles/{id}/RelatedProfiles/{relationTypeId} |
No documentation available. |
| GET Profiles/{id}/Contacts |
No documentation available. |
| GET Profiles/{id}/Certifications/Activities |
No documentation available. |
| GET Profiles/{id}/Certifications/Types |
No documentation available. |
| GET profile/{id}/Events |
Gets the events associated with this profile |
| GET profile/{id}/Registrations |
Gets the event registrations associated with this profile |
| GET profile/{id}/Attendees |
Gets the event attendees associated with this profile |
| GET Profile/{id}/EventActivity |
No documentation available. |
| GET Profile/CustomField/{id} |
No documentation available. |
| POST Profile/CustomField |
No documentation available. |
| POST Profile/CustomFieldUpsert |
No documentation available. |
| PUT Profile/CustomField |
No documentation available. |
| DELETE Profile/CustomField/{id} |
No documentation available. |
| DELETE Profile/{id}/Email/{emailId} |
No documentation available. |
| GET Profile/CustomFields |
No documentation available. |
| GET Profile/CustomFields/{id}/AvailableValues |
No documentation available. |
| GET Profile/{profileId}/AvatarInfo |
No documentation available. |
| GET Profiles/{profileid}/ProfileImage |
No documentation available. |
| POST Profiles/{id}/ProfileImage |
No documentation available. |
| PUT Profiles/{id}/ProfileImage |
No documentation available. |
| DELETE Profiles/{profileid}/ProfileImage |
No documentation available. |
| POST Profile/{profileId}/UpsertRemoteProfileImage |
No documentation available. |
| POST Profiles/{id}/UploadProfileImage |
No documentation available. |
| GET Profile/{id}/Emails |
No documentation available. |
| GET Profile/{id}/Email/{emailId} |
No documentation available. |
| POST Profile/{id}/Email |
No documentation available. |
| PUT Profile/{id}/Email/{emailId} |
No documentation available. |
| GET Profiles/Phones |
Search for Profile Phone |
| GET Profile/{profileId}/Phones |
Get for Phones for given profile ID |
| POST Profiles/Phones |
Create a Profile Phone |
| GET Profiles/Phone/{id} |
Get a Profile Phone |
| PUT Profiles/Phone/{id} |
Update a Profile Phone |
| DELETE Profiles/Phone/{id} |
Delete a Profile Phone |
| GET Profiles/Addresses |
Search for Profile Address |
| GET Profile/{profileId}/Addresses |
Get for Addresses for given profile ID |
| GET Profile/{profileId}/PublicAddresses |
Get for public Addresses for given profile ID |
| POST Profiles/Addresses |
Create a Profile Address |
| GET Profiles/Address/{id} |
Get a Profile Address |
| PUT Profiles/Address/{id} |
Update a Profile Address |
| DELETE Profiles/Address/{id} |
Delete a Profile Address |
| GET Locations |
No documentation available. |
| GET Profile/{id}/Listings |
No documentation available. |
| GET Profiles/PhoneTypes |
Search for Phone Types |
| POST Profiles/PhoneTypes |
Create a phone types |
| GET Profiles/PhoneType/{id} |
get a phone type |
| PUT Profiles/PhoneType/{id} |
update a phone type |
| DELETE Profiles/PhoneType/{id} |
update a phone type |
| GET Profiles/EmailAddressTypes |
Search for Email Types |
| POST Profiles/EmailAddressTypes |
Create an email type |
| GET Profiles/EmailAddressType/{id} |
Get an email type |
| PUT Profiles/EmailAddressType/{id} |
update an email type |
| DELETE Profiles/EmailAddressType/{id} |
delete an email type |
| GET Profiles/AddressTypes |
Search for Address Types |
| GET Profiles/AddressTypes/BillingAndMailingDefaults |
No documentation available. |
| POST Profiles/AddressTypes |
Create an Address Type |
| GET Profiles/AddressType/{id} |
Get an Address Type |
| PUT Profiles/AddressType/{id} |
Update an Address Type |
| DELETE Profiles/AddressType/{id} |
Delete an Address Type |
| GET Profiles/SocialMedias |
Search for Profile SocialMedia |
| GET Profile/{profileId}/SocialMedias |
Get for SocialMedias for given profile ID |
| POST Profile/SocialMedias |
Create a Profile SocialMedia |
| GET Profiles/SocialMedia/{id} |
Get a Profile SocialMedia |
| PUT Profiles/SocialMedia/{id} |
Update a Profile SocialMedia |
| DELETE Profiles/SocialMedia/{id} |
Delete a Profile SocialMedia |
| GET Profiles/SocialMediaTypes |
Search for SocialMediaTypes |
| GET Profile/{profileId}/ProfilePermissions |
Get permission a profile has |
| POST Profile/{profileId}/ProfilePermissions |
Create a profile permissions |
| DELETE Profile/{profileId}/ProfilePermission/{id} |
Delete a profile permissions |
| GET Profile/{profileId}/ProxyableProfileIds |
Profiles the given ID can proxy as |
| GET Profile/{profileId}/ProfileIdsWithSecurityRight/{right} |
Profiles ids that have the given right to the given profile ID |
| GET Profile/{profileId}/GetProfileIdsAndGrantMethodWithSecurityRight/{right} |
Profiles ids and Granting Method that have the given right to the given profile ID |
| GET Profile/{profileId}/CanEditProfile/{targetId} |
Can the profile edit the given ID |
| GET Profile/{profileId}/ProfileEditPermissionGrantMethod/{targetId} |
Can the profile edit the given ID |
| GET Profile/{profileId}/MembershipLevel |
Get membership level that is currently assigned to the given profileId |
| GET Profile/{profileId}/MembershipLevelMin | |
| GET Profile/{profileId}/AutoAssignedMembershipLevel |
if membership level config is set to use an auto-assign formula, run the formula for the given and return the membership level. Does not apply changes, only returns the membership level. |
| POST Profile/{profileId}/PreviewAutoAssignedMembershipLevel |
given an auto-assign formula (as a string), run the formula for the given and return the membership level. Does not apply changes, only returns the membership level. |
| PUT Profile/{profileId}/MembershipLevel/{oldMembershipLevelId}/{newMembershipLevelId} |
change a level for a given profile id |
| PUT Profile/{profileId}/Member/MemberSince |
Updates the profile's MemberSince date |
| PUT Profile/{profileId}/Member/MemberSource |
No documentation available. |
| PUT Profile/{profileId}/Member/MemberNotes |
No documentation available. |
| GET Profile/{profileId}/AutoRevCalc/{arcId}/Amount |
get the calculated amount for the given ARC for the given Profile |
| GET Profile/{id}/Aging |
No documentation available. |
| GET Profile/{id}/InvoiceHistory |
No documentation available. |
| GET Profile/{id}/TotalAmountDue |
No documentation available. |
| GET Profile/{id}/AnnualDues |
No documentation available. |
| GET Profile/{profileId}/Billings?inactive={inactive} |
Gets the billings for a given profile id |
| GET Profile/{profileId}/OpenInvoiceSummary |
No documentation available. |
| GET Profile/{id}/MemberActivity |
No documentation available. |
| GET Profile/RecentContacts |
No documentation available. |
| GET Profile/{profileId}/Tasks |
No documentation available. |
| PUT Profile/{id}/UpdateInheritedProfiles |
No documentation available. |
| GET Profile/{id}/InvoiceDefaults |
No documentation available. |
| POST Profiles/AssignToUser/{userId} |
Assign profiles to a user. |
| POST Profiles/SetStatus/{statusId} |
Set status of multiple profiles. |
| POST Profiles/SetProspect |
Sets the given profiles that are not members to prospects. |
| POST Profiles/CreateContact |
Sets the given profiles that are not members to prospects. |
| GET Profile/{profileId}/Notes |
Loads profile notes text from database. |
| POST Profile/{profileId}/Notes |
Upserts the ProfileNotes value for a given ProfileId. |
| GET Profile/{profileId}/AccessGuid |
No documentation available. |
| GET Profiles/QuickSearch?keyword={keyword} |
No documentation available. |
ProfileAccessGuid
| API | Description |
|---|---|
| GET ProfileAccessGuid/{guid} |
No documentation available. |
ProfileAdvancedSearch
| API | Description |
|---|---|
| POST Profile/AdvancedSearch |
No documentation available. |
| POST Profile/AdvancedSearch/SubAtomic |
Placeholder. Implement when needed. Bare minimum needed from an advanced search would be just the profile IDs. |
| POST Profile/AdvancedSearch/Atomic |
A little more than bare minimum. This is an alias for "Profile/AdvancedSearch" advanced search resultset. |
| POST Profile/AdvancedSearch/Molecular |
Placeholder. Implement when needed. Performs an advanced search, returning an array of . |
| POST Profile/AdvancedSearch/Organic |
Placeholder. Implement when needed. Performs an advanced search, returning an array of for those rare occasions that require every child relationship under the profile. |
| GET Profile/AdvancedSearch/CommonDataViews |
No documentation available. |
| GET Profile/AdvancedSearch/MyDataViews |
No documentation available. |
| GET Profile/AdvancedSearch/MyDataViews/{id} |
No documentation available. |
| POST Profile/AdvancedSearch/Save |
No documentation available. |
| POST Profile/AdvancedSearch/CSV |
No documentation available. |
ProfileCertificationType
| API | Description |
|---|---|
| GET Profiles/Certifications/Types |
Perform a paginated search of certification types given a search string Returns all Profile Certification Types if no search criteria given |
| GET Profiles/Certifications/Types/EmailCsv |
Just like a search, but exports the data as CSV |
| GET Profiles/Certifications/Type/{id} |
Returns a Profile Certification Type from a given Profile CertificationTypeID |
| POST Profiles/Certifications/Types |
Inserts a new Profile Certification Type returning the newly inserted CertificationTypeID |
| PUT Profiles/Certifications/Type/{id} |
Updates a Certification Type for a given Profile Certification Type Domain Entity |
| DELETE Profiles/Certifications/Type/{id} |
deletes a Profile Certification Type for a given Profile Certification Type Domain Entity |
| PUT Profiles/Certifications/Type/{id}/Recertify |
Updates a Certification Type for a given Profile Certification Type Domain Entity |
| GET Profile/{id}/Certifications |
Returns a paged result dto of all certifications for a given profile id. |
ProfileChange
| API | Description |
|---|---|
| GET ProfilesChanged |
No documentation available. |
| GET ProfileChangeTypes |
No documentation available. |
ProfileCustomField
| API | Description |
|---|---|
| GET Profile/{id}/CustomFields |
No documentation available. |
| POST Profile/{id}/CustomFields |
No documentation available. |
| PUT Profile/{profileId}/CustomFields/{customFieldId} |
No documentation available. |
| DELETE Profile/{profileId}/CustomFields/{customFieldId} |
No documentation available. |
ProfileImport
| API | Description |
|---|---|
| GET Profile/Import/Excel/Template |
Download a tempalte Excel file for importing profiles |
| POST Profile/Import/Excel/Validation |
Expects a MultipartFormDataContent with a file stream that is the excel file and a parameter called configJson |
| POST Profile/Import/Excel |
No documentation available. |
ProfileMerge
| API | Description |
|---|---|
| PUT ProfileMerge |
Merge |
ProfileNotification
| API | Description |
|---|---|
| GET Profile/{id}/Notifications |
No documentation available. |
ProfilePermission
| API | Description |
|---|---|
| GET ProfilePermissions |
Search |
| POST ProfilePermissions |
Create |
| GET ProfilePermission/{id} |
Get |
| PUT ProfilePermission/{id} |
Update |
| DELETE ProfilePermission/{id} |
Delete |
ProfilePortal
Profile portal credential manager
| API | Description |
|---|---|
| POST profiles/portal/credential/reset/request | |
| POST profiles/portal/credential/reset/update |
Updates a profiles portal password |
| GET Profile/{id}/PortalSwitchingAccessList |
No documentation available. |
| GET Profile/{id}/HasPortalAccess |
No documentation available. |
ProfileReferral
| API | Description |
|---|---|
| GET Profile/{id}/ProfileViewReferralSummary |
No documentation available. |
ProfileRelation
| API | Description |
|---|---|
| GET ProfileRelations |
Get all or search for profile relations |
| PUT ProfileRelations |
Create a profile relation |
| GET ProfileRelation/{id} |
Get a profile relation |
| PUT ProfileRelation/{id} |
update a profile relation |
| DELETE ProfileRelation/{id} |
Delete a profile relation |
| DELETE ProfileRelation/{id}/Remove |
Remove a profile relation |
| GET ProfileRelations/Roles/{id} |
No documentation available. |
| GET ProfileRelations/Roles |
No documentation available. |
| POST ProfileRelations/Roles |
No documentation available. |
| PUT ProfileRelations/Roles/{id} |
No documentation available. |
| DELETE ProfileRelations/Roles/{id} |
No documentation available. |
| GET Profile/{id}/ProfileAndRelatedProfiles |
No documentation available. |
| GET Profile/{id}/ProfileAndPrimaryRelatedProfiles |
No documentation available. |
| GET profile/{profileId}/MainContact |
Gets the main contact for the givein profile id. Null if no main contact. |
| GET profile/{profileId}/BillingContact |
Gets the billing contact for the given profile id |
| GET Profile/{profileId}/RelationsWithRights |
Get profile relationships for given profile and it's access rights attached to the profile relation |
| GET ProfileRelation/{id}/RelationWithRights |
Get a profile relation with edit rights |
| GET Profile/{profileId}/IsPrimarilyRelatedToMember |
check if given profile is related to a member profile by primary relationn type |
| GET Profile/ProfileViewPrimaryRelations |
No documentation available. |
| GET Profile/ProfileRelationsForManagement |
No documentation available. |
| POST Profile/Relation/Upsert |
No documentation available. |
ProfileRestore
| API | Description |
|---|---|
| GET Profile/{id}/Restore |
No documentation available. |
| GET Profiles/Deleted |
No documentation available. |
| GET Profile/{id}/Deleted/MainContact |
No documentation available. |
ProfileSearchAction
| API | Description |
|---|---|
| POST Profiles/MemberActivity/Advanced |
Creates member activity based on search parameters provided in . |
| POST Affiliation/{AffId}/AddAffiliationToProfiles/Advanced |
Add profiles from the given search to the given affiliation. |
| POST MembershipLevel/{id}/AssignToProfiles/Advanced |
Trigger assign given profiles to the given level. |
| POST Profiles/AssignToUser/{userId}/Advanced |
Assign profiles to a user. |
| POST Profiles/SetStatus/{statusId}/Advanced |
Set status of multiple profiles. |
| POST Profiles/SetProspect/Advanced |
Sets profiles results from an advanced search that are not members to prospects. |
| POST Profiles/CreateContact/Advanced |
Sets profiles results from an advanced search that are not members to prospects. |
| POST Affiliation/{AffId}/RemoveProfilesFromAffiliation/Advanced |
Performs a search and removes the resulting profiles from the given affiliation. |
| POST Tasks/CreateTasks/Advanced |
No documentation available. |
ProfileStatus
| API | Description |
|---|---|
| GET MemberType/{id} |
Gets a MemberType from the database |
| POST MemberTypes |
Creates a new MemberType and inserts it into the database |
| PUT MemberType/{id} |
Updates a MemberType in the database |
| PUT MemberType/{id}/ProfileUpdate |
No documentation available. |
| DELETE MemberType/{id}?memberTypeToMigrateTo={memberTypeToMigrateTo} |
Deletes a MemberType from the database |
| GET MemberTypes |
Searches for MemberTypes in the database |
ProfileType
| API | Description |
|---|---|
| GET ProfileTypes |
No documentation available. |
| GET ProfileTypesForAssociation |
get profile types that are for this customer's association vertical |
ProfileUpdateHT
Profile change requests by other profiles Going to need to add premission checking once it's figured out by Product Owner and Client
| API | Description |
|---|---|
| GET ProfileUpdateHTs |
Search |
| POST ProfileUpdateHTs |
Create |
| GET ProfileUpdateHT/{id} |
Get |
| PUT ProfileUpdateHT/{id} |
Update |
| DELETE ProfileUpdateHT/{id} |
Delete |
| GET profileUpdateHTs/profile/{profileId} |
Get Profile |
| POST ProfileUpdateHTs/profiles |
Save Profile Changes to added profiles (profileId is zero, so can't check permission access) |
| GET ProfileUpdateHT/{id}/profile |
get editable profile off the given profileupdateht id's record. if approved or rejected, then returns null. This really is only needed for geting the profile of added relations. the ProfileUpdateHTs/profile/{profileId:INT} is better for existing profiles. has to check permission manually as identifiers are on the profileUpdateHt record. |
| POST ProfileUpdateHTs/profile/{profileId} |
Save Profile Changes and updates the profileUpdateHt accourdingly |
| GET ProfileUpdateHTs/profile/{profileId}/Listings |
Get listings for given profile id. Authenticated User must have permission to the profile |
| GET ProfileUpdateHTs/Listings/Categories |
Get a list of all listing categories |
| GET ProfileUpdateHTs/Listings/SubCategories |
Get a list of all listing sub categories |
| GET ProfileUpdateHTs/Listings/{categoryId}/SubCategories |
Get a list of listing sub categories for a given listing category id |
| GET ProfileUpdateHTs/profile/{profileId}/EditableProfileRelations |
Get all or search for profile primary relations related to the given profileid |
| GET ProfileUpdateHTs/profile/{profileId}/NewRelatedEditableProfile |
gets pending profile add requests related to the given profileid (for editing) |
| GET ProfileUpdateHTs/ProfileRelation/{id} |
Get a profile relation |
ProfileUpdateHtV2
| API | Description |
|---|---|
| GET profileUpdateHTs/v2/request/{requestId} |
No documentation available. |
| GET ProfileUpdateHTs/v2 |
No documentation available. |
| GET profileUpdateHTs/v2/profile/{profileId}/live |
No documentation available. |
| PUT ProfileUpdateHTs/v2/{id} |
No documentation available. |
| PUT ProfileUpdateHTs/v2/{id}/modify |
No documentation available. |
| GET profileUpdateHTs/v2/profile/{profileId} |
Get Profile |
| POST ProfileUpdateHTs/v2/profile/{profileId} |
No documentation available. |
| PUT ProfileUpdateHts/v2/ApproveAll |
No documentation available. |
| POST ProfileUpdateHTs/v2/CreateNewProfile |
No documentation available. |
ProfileWidget
| API | Description |
|---|---|
| GET Profile/{profileId}/ProfileWidget |
Get widgets from Profile ID |
| PUT ProfileWidget/{id} |
Updates widget |
| POST ProfileWidget |
Creates new Widget |
| DELETE ProfileWidget/{id} |
Deletes Profile Widget |