Thursday, November 21, 2024

Client - Prospect Relationship
Action:
GET
Method:
GET
URL: /api/v1/client/prospectrelationship/get
Description: Fetch a Client Prospect Relationship for a Client Prospect Group and Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params ClientProspectID Int32 Client Prospect Identifier
Params UniqueID Int32 Unique Identifier (optional - value defaulted to 0 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Prospect Relationship for a Client Prospect Group and Client Prospect
{
 "ClientProspectGroupID": 1,
 "ClientProspectID": "450001",
 "ProspectRelationshipID": 1
 "ProspectRelationshipName": "Director"
 "ParentClientProspectID": 0,
 "ParentUniqueID": 0,
 "OriginClientProspectID": 0,
 "UniqueID": "1",
 "UBOOwnershipPercentage": 0,
 "DirectOwnershipPercentage": 0,
 "Value1": 1.123456789,
 "Value2": 0,
 "Value3": 0,
 "Value4": 0,
 "Value5": 0,
 "Value6": 0,
 "Value7": 0,
 "Value1Name": "",
 "Value2Name": "",
 "Value3Name": "",
 "Value4Name": "",
 "Value5Name": "",
 "Value6Name": "",
 "Value7Name": "",
 "Value1Formatted": 1.234,
 "Value2Formatted": 0,
 "Value3Formatted": 0,
 "Value4Formatted": 0,
 "Value5Formatted": 0,
 "Value6Formatted": 0,
 "Value7Formatted": 0,
 "Value1Enabled": true,
 "Value2Enabled": false,
 "Value3Enabled": false,
 "Value4Enabled": false,
 "Value5Enabled": false,
 "Value6Enabled": false,
 "Value7Enabled": false,
 "ClientID": 100
 "ClientName": "Demo Client"
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "DateLastChanged": "2020-08-03 00:00:00",
 "LastChangedByUserID": 137
}]
Field Data Type
ClientProspectGroupID Int32
ClientProspectID Int32
UniqueID Int32
ProspectRelationshipID Int16
ProspectRelationshipName Text 150
ParentClientProspectID Int32
ParentUniqueID Int32
OriginClientProspectID Int32
UBOOwnershipPercentage Int32
DirectOwnershipPercentage Int32
Value1 Decimal
Value2 Decimal
Value3 Decimal
Value4 Decimal
Value5 Decimal
Value6 Decimal
Value7 Decimal
Value1Name String
Value2Name String
Value3Name String
Value4Name String
Value5Name String
Value6Name String
Value7Name String
Value1Formatted String
Value2Formatted String
Value3Formatted String
Value4Formatted String
Value5Formatted String
Value6Formatted String
Value7Formatted String
Value1Enabled Boolean
Value2Enabled Boolean
Value3Enabled Boolean
Value4Enabled Boolean
Value5Enabled Boolean
Value6Enabled Boolean
Value7Enabled Boolean
ClientID Int16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Test 255
DateLastChanged Date
LastChangedByUserID Int16
Action:
GET ALL
Method:
GET
URL: /api/v1/client/prospectrelationship/getall
Description: Fetch all Client Prospect Relationships for a Client Prospect Group
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Prospect Relationships for a Client Prospect Group
[{
 "ClientProspectGroupID": 1,
 "ClientProspectID": "450001",
 "ProspectRelationshipID": 1
 "UniqueID": "1",
 "ProspectRelationshipName": "Director"
 "ParentClientProspectID": 0,
 "ParentUniqueID": 0,
 "OriginClientProspectID": 0,
 "UBOOwnershipPercentage": 0,
 "DirectOwnershipPercentage": 0,
 "Value1": 1.123456789,
 "Value2": 0,
 "Value3": 0,
 "Value4": 0,
 "Value5": 0,
 "Value6": 0,
 "Value7": 0,
 "Value1Name": "",
 "Value2Name": "",
 "Value3Name": "",
 "Value4Name": "",
 "Value5Name": "",
 "Value6Name": "",
 "Value7Name": "",
 "Value1Formatted": 1.234,
 "Value2Formatted": 0,
 "Value3Formatted": 0,
 "Value4Formatted": 0,
 "Value5Formatted": 0,
 "Value6Formatted": 0,
 "Value7Formatted": 0,
 "Value1Enabled": true,
 "Value2Enabled": false,
 "Value3Enabled": false,
 "Value4Enabled": false,
 "Value5Enabled": false,
 "Value6Enabled": false,
 "Value7Enabled": false,
 "ClientID": 1
 "ClientName": "Demo Client"
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "DateLastChanged": "2020-08-03 00:00:00",
 "LastChangedByUserID": 137
}]
Field Data Type
ClientProspectGroupID Int32
ClientProspectID Int32
ProspectRelationshipID Int16
UniqueID Int32
ProspectRelationshipName Text 150
ParentClientProspectID Int32
ParentUniqueID Int32
OriginClientProspectID Int32
UBOOwnershipPercentage Int32
DirectOwnershipPercentage Int32
Value1 Decimal
Value2 Decimal
Value3 Decimal
Value4 Decimal
Value5 Decimal
Value6 Decimal
Value7 Decimal
Value1Name String
Value2Name String
Value3Name String
Value4Name String
Value5Name String
Value6Name String
Value7Name String
Value1Formatted String
Value2Formatted String
Value3Formatted String
Value4Formatted String
Value5Formatted String
Value6Formatted String
Value7Formatted String
Value1Enabled Boolean
Value2Enabled Boolean
Value3Enabled Boolean
Value4Enabled Boolean
Value5Enabled Boolean
Value6Enabled Boolean
Value7Enabled Boolean
ClientID Int16
ClientName Text 150
BusinessUnitID Int32
BusinessUnitName Test 255
DateLastChanged Date
LastChangedByUserID Int16
Action:
ADD
Method:
POST
URL: /api/v1/client/prospectrelationship/add
Description: Add a Client Prospect Relationship for a Client Prospect Group and Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body ClientProspectID Int32 Client Prospect Identifier
Body ProspectRelationshipID Int16 Static Prospect Relationship Identifier (zero for no static prospect relationship)
Body ParentClientProspectID Int32 Parent Client Prospect Identifier
Body ParentUniqueID Int32 Parent Unique Identifier (optional - default 0)
Body OriginClientProspectID Int32 Origin Client Prospect Identifer (optional - default 0)
Body UBOOwnershipPercentage Int32 UBO Ownership Percentage (optional - default 0)
Body DirectOwnershipPercentage Int32 Direct Ownership Percentage (optional - default 0)
Body Value1 Decimal Value 1 (optional - default 0)
Body Value2 Decimal Value 2 (optional - default 0)
Body Value3 Decimal Value 3 (optional - default 0)
Body Value4 Decimal Value 4 (optional - default 0)
Body Value5 Decimal Value 5 (optional - default 0)
Body Value6 Decimal Value 6 (optional - default 0)
Body Value7 Decimal Value 7 (optional - default 0)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Prospect Relationship added.
{
 "ClientProspectGroupID": 1,
 "ClientProspectID": 450001,
 "ProspectRelationshipID": 1
 "UniqueID": "1",
 "ProspectRelationshipName": "Director"
 "ParentClientProspectID": 0,
 "ParentUniqueID": 0,
 "OriginClientProspectID": 0,
 "UniqueID": 0,
 "UBOOwnershipPercentage": 0,
 "DirectOwnershipPercentage": 0,
 "Value1": 1.123456789,
 "Value2": 0,
 "Value3": 0,
 "Value4": 0,
 "Value5": 0,
 "Value6": 0,
 "Value7": 0,
 "Value1Name": "",
 "Value2Name": "",
 "Value3Name": "",
 "Value4Name": "",
 "Value5Name": "",
 "Value6Name": "",
 "Value7Name": "",
 "Value1Formatted": 1.234,
 "Value2Formatted": 0,
 "Value3Formatted": 0,
 "Value4Formatted": 0,
 "Value5Formatted": 0,
 "Value6Formatted": 0,
 "Value7Formatted": 0,
 "Value1Enabled": true,
 "Value2Enabled": false,
 "Value3Enabled": false,
 "Value4Enabled": false,
 "Value5Enabled": false,
 "Value6Enabled": false,
 "Value7Enabled": false,
 "ClientID": 100
 "ClientName": "Demo Client"
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
}
Field Data Type
ClientProspectRelationship Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/prospectrelationship/update
Description: Update an existing Client Prospect Relationship for a Client Prospect Group and Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body ClientProspectID Int32 Client Prospect Identifier
Body ProspectRelationshipID Int16 Static Prospect Relationship Identifier (zero for no static prospect relationship)
Body ParentClientProspectID Int32 Parent Client Prospect Identifier
Body ParentUniqueID Int32 Parent Unique Identifier (optional - default 0)
Body OriginClientProspectID Int32 Origin Client Prospect Identifer (optional - default 0)
Body UniqueID Int32 Client Prospect Relationship Unique Identifier (optional - default 0)
Body UBOOwnershipPercentage Int32 UBO Ownership Percentage (optional - default 0)
Body DirectOwnershipPercentage Int32 Direct Ownership Percentage (optional - default 0)
Body Value1 Decimal Value 1 (optional - default 0)
Body Value2 Decimal Value 2 (optional - default 0)
Body Value3 Decimal Value 3 (optional - default 0)
Body Value4 Decimal Value 4 (optional - default 0)
Body Value5 Decimal Value 5 (optional - default 0)
Body Value6 Decimal Value 6 (optional - default 0)
Body Value7 Decimal Value 7 (optional - default 0)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Prospect Relationship updated.
{
 "ClientProspectGroupID": 1,
 "ClientProspectID": "450001",
 "ProspectRelationshipID": 1
 "ProspectRelationshipName": "Director"
 "ParentClientProspectID": 0,
 "ParentUniqueID": 0,
 "OriginClientProspectID": 0,
 "UniqueID": "1",
 "UBOOwnershipPercentage": 0,
 "DirectOwnershipPercentage": 0,
 "Value1": 1.123456789,
 "Value2": 0,
 "Value3": 0,
 "Value4": 0,
 "Value5": 0,
 "Value6": 0,
 "Value7": 0,
 "Value1Name": "",
 "Value2Name": "",
 "Value3Name": "",
 "Value4Name": "",
 "Value5Name": "",
 "Value6Name": "",
 "Value7Name": "",
 "Value1Formatted": 1.234,
 "Value2Formatted": 0,
 "Value3Formatted": 0,
 "Value4Formatted": 0,
 "Value5Formatted": 0,
 "Value6Formatted": 0,
 "Value7Formatted": 0,
 "Value1Enabled": true,
 "Value2Enabled": false,
 "Value3Enabled": false,
 "Value4Enabled": false,
 "Value5Enabled": false,
 "Value6Enabled": false,
 "Value7Enabled": false,
 "ClientID": 100
 "ClientName": "Demo Client"
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
}
Field Data Type
ClientProspectRelationship Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/prospectrelationship/delete
Description: Delete an existing Client Prospect Relationship for a Client Prospect Group and Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params ClientProspectID Int32 Client Prospect Identifier
Params UniqueID Int32 Unique Identifier (optional - default 0)
Params ActionUserID Int16 Identifier of the User performing action.
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Prospect Relationship deleted.
{
 "ClientProspectGroupID": 1,
 "ClientProspectID": "450001",
 "ProspectRelationshipID": 1
 "ProspectRelationshipName": "Director"
 "ParentClientProspectID": 0,
 "ParentUniqueID": 0,
 "OriginClientProspectID": 0,
 "UniqueID": "1",
 "UBOOwnershipPercentage": 0,
 "DirectOwnershipPercentage": 0,
 "Value1": 1.123456789,
 "Value2": 0,
 "Value3": 0,
 "Value4": 0,
 "Value5": 0,
 "Value6": 0,
 "Value7": 0,
 "Value1Name": "",
 "Value2Name": "",
 "Value3Name": "",
 "Value4Name": "",
 "Value5Name": "",
 "Value6Name": "",
 "Value7Name": "",
 "Value1Formatted": 1.234,
 "Value2Formatted": 0,
 "Value3Formatted": 0,
 "Value4Formatted": 0,
 "Value5Formatted": 0,
 "Value6Formatted": 0,
 "Value7Formatted": 0,
 "Value1Enabled": true,
 "Value2Enabled": false,
 "Value3Enabled": false,
 "Value4Enabled": false,
 "Value5Enabled": false,
 "Value6Enabled": false,
 "Value7Enabled": false,
 "ClientID": 100
 "ClientName": "Demo Client"
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
}
Field Data Type
ClientProspectRelationship Collection
 Same as Get Method results above.