Tuesday, July 16, 2024

Static - Onboarding Type Property Group Link
Action:
GET
Method:
GET
URL: /api/v1/static/onboardingtypepropertygrouplink/get
Description: Fetch a Static Onboarding Type Property Group link record
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params OnboardingPropertyGroupID Int32 Onboarding Property Group Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Property Group record updated.
{
 "OnboardingTypeID": 200,
 "OnboardingPropertyGroupID": 52003,
 "PropertyGroupOrder": 4,
 "Section": 3,
 "Hidden": false,
 "Responsive": 1
 "OnboardingTypeName": "Person",
 "OnboardingTypeDescription": "Person Gibraltar",
 "OnboardingPropertyGroupName": "Salary",
 "OnboardingPropertyGroupDescription": "Salary"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingPropertyGroupID Int 32
PropertyGroupOrder Byte
Section Byte
Hidden Boolean
Responsive Byte
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingPropertyGroupName Text 300
OnboardingPropertyGroupDescription Text 600
Action:
GET ALL
Method:
GET
URL: /api/v1/static/onboardingtypepropertygrouplink/getall
Description: Fetch all Static Onboarding Property Groups 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 Property Group record updated.
{
 "OnboardingTypeID": 200,
 "OnboardingPropertyGroupID": 52003,
 "PropertyGroupOrder": 4,
 "Section": 3,
 "Hidden": false,
 "Responsive": 1
 "OnboardingTypeName": "Person",
 "OnboardingTypeDescription": "Person Gibraltar",
 "OnboardingPropertyGroupName": "Salary",
 "OnboardingPropertyGroupDescription": "Salary"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingPropertyGroupID Int 32
PropertyGroupOrder Byte
Section Byte
Hidden Boolean
Responsive Byte
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingPropertyGroupName Text 300
OnboardingPropertyGroupDescription Text 600
Action:
UPDATE
Method:
PUT
URL: /api/v1/static/onboardingtypepropertygrouplink/update
Description: Update an existing Static Onboarding Property Group 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 to be linked
Body OnboardingPropertyGroupID Int32 Property Group Identifier
Body PropertyGroupOrder Byte Order of the property group
Body Section Byte Section number of the property group
Body Hidden Boolean Is the property group hidden? (True = Yes, Default value false if left blank)
Body Responsive Byte Is the property responsive? (0 = No, 1 = Yes Show Initially, 2 = Yes Hide Initially)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Property Group record updated.
{
 "OnboardingTypeID": 200,
 "OnboardingPropertyGroupID": 52003,
 "PropertyGroupOrder": 4,
 "Section": 3,
 "Hidden": false,
 "Responsive": 1
 "OnboardingTypeName": "Person",
 "OnboardingTypeDescription": "Person Gibraltar",
 "OnboardingPropertyGroupName": "Salary",
 "OnboardingPropertyGroupDescription": "Salary"
}
Field Data Type
OnboardingTypeID Int 32
OnboardingPropertyGroupID Int 32
PropertyGroupOrder Byte
Section Byte
Hidden Boolean
Responsive Byte
OnboardingTypeName Text 300
OnboardingTypeDescription Text 500
OnboardingPropertyGroupName Text 300
OnboardingPropertyGroupDescription Text 600