Tuesday, July 16, 2024

Client - Onboarding Store
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingstore/get
Description: Fetch a Client Onboarding Store record for a combination of Client Onboarding ID and Client Prospect ID
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 ClientProspectID Int32 Client Prospect Identifier
Params ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Params OnboardingPropertyGroupID Int32 Client Onboarding Property Group Id
Params OnboardingPropertyID Int32 Client Onboarding Property Id
Params StoreID Byte Static Store Id
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Store for the Client Onboarding Id associated with a Client Prospect ID
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingPropertyGroupID": 52001,
 "OnboardingPropertyReferenceID": "R2",
 "OnBoardingPropertyDataType": "List",
 "OnBoardingPropertyDataValue": "Jersey",
 "OnboardingPropertyID": 51003,
 "StoreID": 5,
 "Integer": null,
 "Decimal": null,
 "Text": ""
 "Date": null,
 "ListGroupID": 33000,
 "ListGroupName": Country,
 "ListDataID": 34239,
 "ListDataName": Jersey,
 "IsImported": false,
 "DateLastChanged": "2023-10-04 09:48:13",
 "LastChangedByUserID": 107
}]
Field Data Type
BusinessUnitID Int32
ClientProspectID Int32
ClientOnboardingID Int32
OnboardingPropertyGroupID Int32
OnboardingPropertyReferenceID Text
OnBoardingPropertyDataType Text
OnBoardingPropertyDataValue Text
OnboardingPropertyID Int32
OnboardingPropertyName Text
StoreID Byte
Integer Int32
Decimal Decimal
Text Text 2GB
Date Date
ListGroupID Int32
ListGroupName Text
ListDataID Int32
ListDataName Text
IsImported Boolean
DateLastChanged Date
LastChangedByUserID Int32
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingstore/getall
Description: Fetch all Client Onboarding Store records for a combination of Client Onboarding ID and Client Prospect ID
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 ClientProspectID Int32 Client Prospect Identifier
Params ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Params OnboardingPropertyGroupID Int32 Client Onboarding Property Group Id (Optional)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of one or many Client Onboarding Stores
[{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingPropertyGroupID": 52001,
 "OnboardingPropertyReferenceID": "R2",
 "OnBoardingPropertyDataType": "List",
 "OnBoardingPropertyDataValue": "Jersey",
 "OnboardingPropertyID": 51003,
 "StoreID": 5,
 "Integer": null,
 "Decimal": null,
 "Text": ""
 "Date": null,
 "ListGroupID": 33000,
 "ListGroupName": Country,
 "ListDataID": 34239,
 "ListDataName": Jersey,
 "IsImported": false,
 "DateLastChanged": "2023-10-04 09:48:13",
 "LastChangedByUserID": 107
}]
Field Data Type
BusinessUnitID Int32
ClientProspectID Int32
ClientOnboardingID Int32
OnboardingPropertyGroupID Int32
OnboardingPropertyReferenceID Text
OnBoardingPropertyDataType Text
OnBoardingPropertyDataValue Text
OnboardingPropertyID Int32
OnboardingPropertyName Text
StoreID Byte
Integer Int32
Decimal Decimal
Text Text 2GB
Date Date
ListGroupID Int32
ListGroupName Text
ListDataID Int32
ListDataName Text
IsImported Boolean
DateLastChanged Date
LastChangedByUserID Int32
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingstore/add
Description: Add a Client Onboarding Store for a combination of Client Onboarding ID and Client Prospect ID
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 ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect Id
Body OnboardingPropertyGroupID Int32 Client Onboarding Property Group Id
Body OnboardingPropertyID Int32 Client Onboarding Property Id
Body StoreID Byte Static Store Id
Body Integer Int32 Integer value to set or blank
Body Decimal Decimal Decimal value to set or blank
Body Text Text 2GB Text value to set or blank
Body Date Date Date to be set (yyyy-mm-dd or blank)
Body ListGroupID Int32 List Group Id or blank
Body ListDataID Int32 List data Id of the associated List Group Id or blank
Body IsImported Boolean 0 = No, 1= Yes
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Store added.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingPropertyGroupID": 52001,
 "OnboardingPropertyReferenceID": "R2",
 "OnBoardingPropertyDataType": "List",
 "OnBoardingPropertyDataValue": "Jersey",
 "OnboardingPropertyID": 51003,
 "StoreID": 5,
 "Integer": null,
 "Decimal": null,
 "Text": ""
 "Date": null,
 "ListGroupID": 33000,
 "ListGroupName": Country,
 "ListDataID": 34239,
 "ListDataName": Jersey,
 "IsImported": false,
 "DateLastChanged": "2023-10-04 09:48:13",
 "LastChangedByUserID": 107
}
Field Data Type
ClientOnboardingStore Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingstore/update
Description: Update a Client Onboarding Store for a combination of Client Onboarding ID and Client Prospect ID
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 ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect Id
Body OnboardingPropertyGroupID Int32 Client Onboarding Property Group Id
Body OnboardingPropertyID Int32 Client Onboarding Property Id
Body StoreID Byte Static Store Id
Body Integer Int32 Integer value to set or blank
Body Decimal Decimal Decimal value to set or blank
Body Text Text 2GB Text value to set or blank
Body Date Date Date to be set (yyyy-mm-dd or blank)
Body ListGroupID Int32 List Group Id or blank
Body ListDataID Int32 List data Id of the associated List Group Id or blank
Body IsImported Boolean 0 = No, 1= Yes
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Store updated.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingPropertyGroupID": 52001,
 "OnboardingPropertyReferenceID": "R2",
 "OnBoardingPropertyDataType": "List",
 "OnBoardingPropertyDataValue": "Jersey",
 "OnboardingPropertyID": 51003,
 "StoreID": 5,
 "Integer": null,
 "Decimal": null,
 "Text": ""
 "Date": null,
 "ListGroupID": 33000,
 "ListGroupName": Country,
 "ListDataID": 34239,
 "ListDataName": Jersey,
 "IsImported": false,
 "DateLastChanged": "2023-10-04 09:48:13",
 "LastChangedByUserID": 107
}
Field Data Type
ClientOnboardingStore Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingstore/delete
Description: Delete a Client Store for a combination of Client Onboarding ID and Client Prospect ID
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 ClientProspectID Int32 Client Prospect Identifier
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body OnboardingPropertyGroupID Int32 Client Onboarding Property Group Id
Body OnboardingPropertyID Int32 Client Onboarding Property Id
Body StoreID Byte Static Store Id
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Store deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingPropertyGroupID": 52001,
 "OnboardingPropertyReferenceID": "R2",
 "OnBoardingPropertyDataType": "List",
 "OnBoardingPropertyDataValue": "Jersey",
 "OnboardingPropertyID": 51003,
 "StoreID": 5,
 "Integer": null,
 "Decimal": null,
 "Text": ""
 "Date": null,
 "ListGroupID": 33000,
 "ListGroupName": Country,
 "ListDataID": 34239,
 "ListDataName": Jersey,
 "IsImported": false,
 "DateLastChanged": "2023-10-04 09:48:13",
 "LastChangedByUserID": 107
} }
Field Data Type
ClientOnboardingStore Collection
 Same as Get Method results above.
Action:
BULKADDBYREF
Method:
POST
URL: /api/v1/client/onboardingstore/bulkaddbyref
Description: Client Onboarding Store - Bulk Add By Ref
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/json
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Identifier
Body ClientOnboardingID Int32 Client Onboarding Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Body DataCollectionData Array Data Collection Data (Json Collection)
Data Collection Data:  "DataCollectionData":[
  {
   "PropertyMappingReferenceID": "R1",
   "PropertyDataValue": "United Kingdom"
   "ListPropertyDataValueType": 2
  },
  {
   "PropertyMappingReferenceID": "R2",
   "PropertyDataValue": "ABCD"
   "ListPropertyDataValueType": 1
  },
  {
   "PropertyMappingReferenceID": "R3",
   "PropertyDataValue": "0.258"
   "ListPropertyDataValueType": 0
  }
 ]
Field Data Type
PropertyMappingReferenceID Text 255
PropertyDataValue Text 8000
ListPropertyDataValueType Int 16
KeyDataTypeNotes
PropertyMappingReferenceIDText 255Property Mapping Reference
PropertyDataValueText 8000Property Data Value
ListPropertyDataValueTypeInt 160 = List Data Identifier; 1 = List Data Reference; 2 = List Data Name
Return Data: Json or XML of Client Onboarding Store Bulk Add Response
{
 "BusinessUnitID": 10,
 "ClientProspectID": 454879,
 "ClientOnboardingID": 304769,
 "DataCollectionData":[
  {
   "PropertyMappingReferenceID": "R1",
   "Status": 0,
   "Message": "",
  },
  {
   "PropertyMappingReferenceID": "R2",
   "Status": 0,
   "Message": "",
  },
  {
   "PropertyMappingReferenceID": "R3",
   "Status": 1,
   "Message": "Value cannot be less than 1.",
  }
 ],
}
Field Data Type
PropertyMappingReferenceID Text 255
Status Int 16
Message Text 8000
KeyDataTypeNotes
PropertyMappingReferenceIDText 255Property Mapping Reference
StatusInt 160 = Success; 1 = Failed;
MessageText 8000Message