API Resources
Profile
Test summary example
| API | Description |
|---|---|
| GET profile/{id} |
Returns basic Profile information |
| GET profile/{id}/extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
Returns extended Profile information including primary related profiles and affiliation codes. 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}/MainOrg/Extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent} |
Returns extended Profile information including primary related profiles and affiliation codes for the Main Organization 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}/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} |
Returns extended Profile information including related profiles |
| GET profile/{id}/ProfileWithListingsAndAffiliations |
Gets A Profile with its Listings and Any Affiliations |
| GET Profiles |
Profile Search End Point |
| GET ProfilesWithMainRelatedProfiles |
The main profile that is returned enforeces the following rule: For Org Profiles => The first related profile that is an individual is returned For Individual Profiles => The first related profile that is an org is returned |
| POST Profiles |
Create the given profile. |
| PUT Profile/{id} |
Update the given profile. |
| 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 ProfileCustomFields |
Returns a list of all Profile Custom Fields defined in the customer database |
| GET Profile/{profileId}/SocialMedias |
Get for SocialMedias for given profile ID |
ProfileCertificationType
| API | Description |
|---|---|
| GET Profiles/Certifications/Types |
Perform a paginated search of Certifications for a given Profile. |
| 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 |
ProfileChange
| API | Description |
|---|---|
| GET ProfilesChanged |
No documentation available. |
| GET ProfileChangeTypes |
No documentation available. |
ProfileCustomFields
| API | Description |
|---|---|
| GET Profile/CustomField/{id} |
Returns Custom Field Information |
| POST Profile/CustomField |
Posts a new CustomField |
| PUT Profile/CustomField |
Updates an existing CustomField |
| PUT Profile/{profileId}/CustomFields/{customFieldId} |
Updates an existing custom field for a Profile |
| GET Profile/{profileId}/CustomFields |
Returns the custom fields associated with a Profile |
| POST Profile/{profileId}/CustomFields |
Posts a new custom field to a Profile |
ProfileMemberActivity
| API | Description |
|---|---|
| GET Profile/{id}/MemberActivity |
Web route to get member activity for a given profile id |
| POST MemberActivity |
Web route to create a new MemberActivity record |
| PUT MemberActivity |
Web route to update a MemberActivity record. |
ProfileRelation
Add, edit, delete profile relations. Profile relations link 2 profiles by Relation Types. 2 profile relation records exist for each relationship each represting one direction of the relationship.
| 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 |
| GET ProfileRelations/Roles/{id} |
Not yet supported. |
| GET ProfileRelations/Roles |
Get all Profile Relation Roles |
| POST ProfileRelations/Roles |
Not yet supported. |
| PUT ProfileRelations/Roles/{id} |
Not yet supported. |
| DELETE ProfileRelations/Roles/{id} |
Not yet supported. |
| GET Profile/{id}/ProfileAndRelatedProfiles |
Gets profile relations for a given profileid |
| GET Profile/{id}/ProfileAndPrimaryRelatedProfiles |
Gets primary profile relations for a given profileid |
| GET ProfilesAndTheirPrimaryRelatedProfiles |
Gets primary profile relations for a given profile search criteria |
| GET profile/{profileId}/MainContact |
Gets the main contact for the givein profile id. Null if no main contact. |
| GET profile/{profileId}/BillingContact |
Gets a profiles billing contact |
| 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 |