Tuesday, July 16, 2024

Static - Onboarding Type Data Document Type Link
Action:
GET
Method:
GET
URL: /api/v1/static/onboardingtypedatadocumenttypelink/get
Description: Fetch a Static Onboarding Type Data Document Type link
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params OnboardingDataDocumentTypeID Int32 Onboarding Data Document Type Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record updated.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 3,
 "Mandatory": false,
 "OnboardingTypeName": "Defence Logic",
 "OnboardingTypeDescription": "Defence Logic",
 "OnboardingDataDocumentTypeName": "Passport",
 "OnboardingDataDocumentTypeDescription": "Passport"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Mandatory Boolean
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingDataDocumentTypeName Text 300
OnboardingDataDocumentTypeDescription Text 500
Action:
GET ALL
Method:
GET
URL: /api/v1/static/onboardingtypedatadocumenttypelink/getall
Description: Fetch all Static Onboarding Data Document Types linked to an Onboarding Type
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record updated.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 3,
 "Mandatory": false,
 "OnboardingTypeName": "Defence Logic",
 "OnboardingTypeDescription": "Defence Logic",
 "OnboardingDataDocumentTypeName": "Passport",
 "OnboardingDataDocumentTypeDescription": "Passport"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Mandatory Boolean
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingDataDocumentTypeName Text 300
OnboardingDataDocumentTypeDescription Text 500
Action:
UPDATE
Method:
PUT
URL: /api/v1/static/onboardingtypedatadocumenttypelink/update
Description: Update an existing Static Onboarding Data Document Type record linked to an Onboarding Type
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body OnboardingTypeID Int32 Onboarding Type Identifier
Body OnboardingDataDocumentTypeID Int32 Onboarding Data Document Type Identifier
Body DataDocumentTypeOrder Byte Order of the Data Document Type(Pass 0 as currently not being used)
Body Mandatory Boolean Is the document type mandatory? (True = Yes, Default value false if left blank)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record updated.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 3,
 "Mandatory": false,
 "OnboardingTypeName": "Defence Logic",
 "OnboardingTypeDescription": "Defence Logic",
 "OnboardingDataDocumentTypeName": "Passport",
 "OnboardingDataDocumentTypeDescription": "Passport"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Mandatory Boolean
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingDataDocumentTypeName Text 300
OnboardingDataDocumentTypeDescription Text 500