Thursday, November 21, 2024

Client - Onboarding Stage
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingstage/get
Description: Fetch a Client Onboarding Stage record for a Client Onboarding ID of a 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 StageID Byte Client Onboarding Stage Id
Params UniqueID Int32 Client Onboarding Stage Unique Id
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Stage for the Client Onboarding Id associated with a Client Prospect ID
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingStageID": 6,
 "StageDate": "2020-07-03 16:00:42",
 "STPNotes": "",
 "STPAuthorisationDate": null,
 "HandlerNotes": "",
 "HandlerUserID": 129,
 "HandlerAuthorisationStatus": 1,
 "HandlerAuthorisationDate": 2024-11-11 00:00:00,
 "Supervisor1UserID": 129,
 "Supervisor1UserName": "John Burns"
 "Supervisor1AuthorisationStatus": 1,
 "Supervisor1AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor1Notes": "",
 "Supervisor2UserID": 129,
 "Supervisor2UserName": "John Burns"
 "Supervisor2AuthorisationStatus": 1,
 "Supervisor2AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor2Notes": "",
 "Manager1UserID": 129,
 "Manager1UserName": "John Burns"
 "Manager1AuthorisationStatus": 1,
 "Manager1AuthorisationDate": 2024-11-16 00:00:00,
 "Manager1Notes": "",
 "Manager2UserID": 129,
 "Manager2UserName": "John Burns"
 "Manager2AuthorisationStatus": 1,
 "Manager2AuthorisationDate": 2024-11-16 00:00:00,
 "Manager2Notes": "",
 "DirectorUserID": 129,
 "DirectorUserName": "John Burns"
 "DirectorAuthorisationStatus": 1,
 "DirectorAuthorisationDate": 2024-11-16 00:00:00,
 "DirectorNotes": "",
 "UniqueID": 2,
 "HandlerUserName": "Steve Smith",
}]
Field Data Type
BusinessUnitID Int32
ProspectID Int32
OnboardingID Int32
OnboardingStageID Byte
StageDate Date
STPNotes Text 4000
STPAuthorisationDate Date
HandlerNotes Text 4000
HandlerUserID Int32
HandlerAuthorisationStatus Byte
HandlerAuthorisationDate Date
Supervisor1UserID Int32
Supervisor1UserName Text 300
Supervisor1AuthorisationStatus Byte
Supervisor1AuthorisationDate Date
Supervisor1Notes Text 4000
Supervisor2UserID Int32
Supervisor2UserName Text 300
Supervisor2AuthorisationStatus Byte
Supervisor2AuthorisationDate Date
Supervisor2Notes Text 4000
Manager1UserID Int32
Manager1UserName Text 300
Manager1AuthorisationStatus Byte
Manager1AuthorisationDate Date
Manager1Notes Text 4000
Manager2UserID Int32
Manager2UserName Text 300
Manager2AuthorisationStatus Byte
Manager2AuthorisationDate Date
Manager2Notes Text 4000
DirectorUserID Int32
DirectorUserName Text 300
DirectorAuthorisationStatus Byte
DirectorAuthorisationDate Date
DirectorNotes Text 4000
UniqueID Int32
HandlerUserName Test 300
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingstage/getall
Description: Fetch all Client Onboarding Stage for a Client Onboarding 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 ReturnFormat String Json or Xml
Return Data: Json or XML collection of one or many Client Onboarding Stages
[{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingStageID": 6,
 "StageDate": "2020-07-03 16:00:42",
 "STPNotes": "",
 "STPAuthorisationDate": null,
 "HandlerNotes": "",
 "HandlerUserID": 129,
 "HandlerAuthorisationStatus": 1,
 "HandlerAuthorisationDate": 2024-11-11 00:00:00,
 "Supervisor1UserID": 129,
 "Supervisor1UserName": "John Burns"
 "Supervisor1AuthorisationStatus": 1,
 "Supervisor1AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor1Notes": "",
 "Supervisor2UserID": 129,
 "Supervisor2UserName": "John Burns"
 "Supervisor2AuthorisationStatus": 1,
 "Supervisor2AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor2Notes": "",
 "Manager1UserID": 129,
 "Manager1UserName": "John Burns"
 "Manager1AuthorisationStatus": 1,
 "Manager1AuthorisationDate": 2024-11-16 00:00:00,
 "Manager1Notes": "",
 "Manager2UserID": 129,
 "Manager2UserName": "John Burns"
 "Manager2AuthorisationStatus": 1,
 "Manager2AuthorisationDate": 2024-11-16 00:00:00,
 "Manager2Notes": "",
 "DirectorUserID": 129,
 "DirectorUserName": "John Burns"
 "DirectorAuthorisationStatus": 1,
 "DirectorAuthorisationDate": 2024-11-16 00:00:00,
 "DirectorNotes": "",
 "UniqueID": 2,
 "HandlerUserName": "Steve Smith",
}]
Field Data Type
BusinessUnitID Int32
ProspectID Int32
OnboardingID Int32
OnboardingStageID Byte
StageDate Date
STPNotes Text 4000
STPAuthorisationDate Date
HandlerNotes Text 4000
HandlerUserID Int32
HandlerAuthorisationStatus Byte
HandlerAuthorisationDate Date
Supervisor1UserID Int32
Supervisor1UserName Text 300
Supervisor1AuthorisationStatus Byte
Supervisor1AuthorisationDate Date
Supervisor1Notes Text 4000
Supervisor2UserID Int32
Supervisor2UserName Text 300
Supervisor2AuthorisationStatus Byte
Supervisor2AuthorisationDate Date
Supervisor2Notes Text 4000
Manager1UserID Int32
Manager1UserName Text 300
Manager1AuthorisationStatus Byte
Manager1AuthorisationDate Date
Manager1Notes Text 4000
Manager2UserID Int32
Manager2UserName Text 300
Manager2AuthorisationStatus Byte
Manager2AuthorisationDate Date
Manager2Notes Text 4000
DirectorUserID Int32
DirectorUserName Text 300
DirectorAuthorisationStatus Byte
DirectorAuthorisationDate Date
DirectorNotes Text 4000
UniqueID Int32
HandlerUserName Test 300
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingstage/add
Description: Add a Client Onboarding Stage 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 OnboardingStageID Byte Client Onboarding Stage Id
Body StageDate Date Client Onboarding Stage Date (yyyy-mm-dd)
Body STPNotes Text 4000 Additional information requested
Body STPAuthorisationDate Date Additional information requested date (yyyy-mm-dd or blank)
Body HandlerNotes Text 4000 Notes added by the handler
Body HandlerUserID Int32 Stage Handler User Id
Body HandlerAuthorisationStatus Byte Authorisation status of the handler
Body HandlerAuthorisationDate Date Date when the handler provided authorisation (yyyy-mm-dd or blank)
Body Supervisor1UserID Int32 Supervisor1 User Id
Body Supervisor1AuthorisationStatus Byte Authorisation status of the Supervisor1
Body Supervisor1AuthorisationDate Date Date when the Supervisor1 provided authorisation (yyyy-mm-dd or blank)
Body Supervisor1Notes Text 4000 Notes added by Supervisor1
Body Supervisor2UserID Int32 Supervisor2 User Id
Body Supervisor2AuthorisationStatus Byte Authorisation status of the Supervisor2
Body Supervisor2AuthorisationDate Date Date when the Supervisor2 provided authorisation (yyyy-mm-dd or blank)
Body Supervisor2Notes Text 4000 Notes added by Supervisor2
Body Manager1UserID Int32 Manager1 User Id
Body Manager1AuthorisationStatus Byte Authorisation status of the Manager1
Body Manager1AuthorisationDate Date Date when the Manager1 provided authorisation (yyyy-mm-dd or blank)
Body Manager1Notes Text 4000 Notes added by Manager1
Body Manager2UserID Int32 Manager2 User Id
Body Manager2AuthorisationStatus Byte Authorisation status of the Manager2
Body Manager2AuthorisationDate Date Date when the Manager2 provided authorisation (yyyy-mm-dd or blank)
Body Manager2Notes Text 4000 Notes added by Manager2
Body DirectorUserID Int32 Director User Id
Body DirectorAuthorisationStatus Byte Authorisation status of the Director
Body DirectorAuthorisationDate Date Date when the Director provided authorisation (yyyy-mm-dd or blank)
Body DirectorNotes Text 4000 Notes added by Director
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Stage added.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingStageID": 6,
 "StageDate": "2020-07-03 16:00:42",
 "STPNotes": "",
 "STPAuthorisationDate": null,
 "HandlerNotes": "",
 "HandlerUserID": 129,
 "HandlerAuthorisationStatus": 1,
 "HandlerAuthorisationDate": 2024-11-11 00:00:00,
 "Supervisor1UserID": 129,
 "Supervisor1UserName": "John Burns"
 "Supervisor1AuthorisationStatus": 1,
 "Supervisor1AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor1Notes": "",
 "Supervisor2UserID": 129,
 "Supervisor2UserName": "John Burns"
 "Supervisor2AuthorisationStatus": 1,
 "Supervisor2AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor2Notes": "",
 "Manager1UserID": 129,
 "Manager1UserName": "John Burns"
 "Manager1AuthorisationStatus": 1,
 "Manager1AuthorisationDate": 2024-11-16 00:00:00,
 "Manager1Notes": "",
 "Manager2UserID": 129,
 "Manager2UserName": "John Burns"
 "Manager2AuthorisationStatus": 1,
 "Manager2AuthorisationDate": 2024-11-16 00:00:00,
 "Manager2Notes": "",
 "DirectorUserID": 129,
 "DirectorUserName": "John Burns"
 "DirectorAuthorisationStatus": 1,
 "DirectorAuthorisationDate": 2024-11-16 00:00:00,
 "DirectorNotes": "",
 "UniqueID": 2,
 "HandlerUserName": "Steve Smith",
}
Field Data Type
ClientOnboardingStage Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingstage/update
Description: Update a Client Onboarding Stage 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 OnboardingStageID Byte Client Onboarding Stage Id
Body UniqueID Int32 Client Onboarding Stage Unique Id
Body StageDate Date Client Onboarding Stage Date (yyyy-mm-dd)
Body STPNotes Text 4000 Additional information requested
Body STPAuthorisationDate Date Additional information requested date (yyyy-mm-dd or blank)
Body HandlerNotes Text 4000 Notes added by the handler
Body HandlerUserID Int32 Stage Handler User Id
Body HandlerAuthorisationStatus Byte Authorisation status of the handler
Body HandlerAuthorisationDate Date Date when the handler provided authorisation (yyyy-mm-dd or blank)
Body Supervisor1UserID Int32 Supervisor1 User Id
Body Supervisor1AuthorisationStatus Byte Authorisation status of the Supervisor1
Body Supervisor1AuthorisationDate Date Date when the Supervisor1 provided authorisation (yyyy-mm-dd or blank)
Body Supervisor1Notes Text 4000 Notes added by Supervisor1
Body Supervisor2UserID Int32 Supervisor2 User Id
Body Supervisor2AuthorisationStatus Byte Authorisation status of the Supervisor2
Body Supervisor2AuthorisationDate Date Date when the Supervisor2 provided authorisation (yyyy-mm-dd or blank)
Body Supervisor2Notes Text 4000 Notes added by Supervisor2
Body Manager1UserID Int32 Manager1 User Id
Body Manager1AuthorisationStatus Byte Authorisation status of the Manager1
Body Manager1AuthorisationDate Date Date when the Manager1 provided authorisation (yyyy-mm-dd or blank)
Body Manager1Notes Text 4000 Notes added by Manager1
Body Manager2UserID Int32 Manager2 User Id
Body Manager2AuthorisationStatus Byte Authorisation status of the Manager2
Body Manager2AuthorisationDate Date Date when the Manager2 provided authorisation (yyyy-mm-dd or blank)
Body Manager2Notes Text 4000 Notes added by Manager2
Body DirectorUserID Int32 Director User Id
Body DirectorAuthorisationStatus Byte Authorisation status of the Director
Body DirectorAuthorisationDate Date Date when the Director provided authorisation (yyyy-mm-dd or blank)
Body DirectorNotes Text 4000 Notes added by Director
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Stage updated.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingStageID": 6,
 "StageDate": "2020-07-03 16:00:42",
 "STPNotes": "",
 "STPAuthorisationDate": null,
 "HandlerNotes": "",
 "HandlerUserID": 129,
 "HandlerAuthorisationStatus": 1,
 "HandlerAuthorisationDate": 2024-11-11 00:00:00,
 "Supervisor1UserID": 129,
 "Supervisor1UserName": "John Burns"
 "Supervisor1AuthorisationStatus": 1,
 "Supervisor1AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor1Notes": "",
 "Supervisor2UserID": 129,
 "Supervisor2UserName": "John Burns"
 "Supervisor2AuthorisationStatus": 1,
 "Supervisor2AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor2Notes": "",
 "Manager1UserID": 129,
 "Manager1UserName": "John Burns"
 "Manager1AuthorisationStatus": 1,
 "Manager1AuthorisationDate": 2024-11-16 00:00:00,
 "Manager1Notes": "",
 "Manager2UserID": 129,
 "Manager2UserName": "John Burns"
 "Manager2AuthorisationStatus": 1,
 "Manager2AuthorisationDate": 2024-11-16 00:00:00,
 "Manager2Notes": "",
 "DirectorUserID": 129,
 "DirectorUserName": "John Burns"
 "DirectorAuthorisationStatus": 1,
 "DirectorAuthorisationDate": 2024-11-16 00:00:00,
 "DirectorNotes": "",
 "UniqueID": 2,
 "HandlerUserName": "Steve Smith",
}
Field Data Type
ClientOnboardingStage Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingstage/delete
Description: Delete a Client Stage 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 StageID Byte Client Onboarding Stage Id
Body UniqueID Int32 Client Onboarding Stage Unique 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 Stage deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": 300001,
 "OnboardingStageID": 6,
 "StageDate": "2020-07-03 16:00:42",
 "STPNotes": "",
 "STPAuthorisationDate": null,
 "HandlerNotes": "",
 "HandlerUserID": 129,
 "HandlerAuthorisationStatus": 1,
 "HandlerAuthorisationDate": 2024-11-11 00:00:00,
 "Supervisor1UserID": 129,
 "Supervisor1UserName": "John Burns"
 "Supervisor1AuthorisationStatus": 1,
 "Supervisor1AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor1Notes": "",
 "Supervisor2UserID": 129,
 "Supervisor2UserName": "John Burns"
 "Supervisor2AuthorisationStatus": 1,
 "Supervisor2AuthorisationDate": 2024-11-16 00:00:00,
 "Supervisor2Notes": "",
 "Manager1UserID": 129,
 "Manager1UserName": "John Burns"
 "Manager1AuthorisationStatus": 1,
 "Manager1AuthorisationDate": 2024-11-16 00:00:00,
 "Manager1Notes": "",
 "Manager2UserID": 129,
 "Manager2UserName": "John Burns"
 "Manager2AuthorisationStatus": 1,
 "Manager2AuthorisationDate": 2024-11-16 00:00:00,
 "Manager2Notes": "",
 "DirectorUserID": 129,
 "DirectorUserName": "John Burns"
 "DirectorAuthorisationStatus": 1,
 "DirectorAuthorisationDate": 2024-11-16 00:00:00,
 "DirectorNotes": "",
 "UniqueID": 2,
 "HandlerUserName": "Steve Smith",
} }
Field Data Type
ClientOnboardingStage Collection
 Same as Get Method results above.