| Action: | GET | |||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||
| URL: | /api/v1/static/onboardingpropertygroup/get | |||||||||||||||||||||
| Description: | Fetch a Static Onboarding Property Group record based on Identifier | |||||||||||||||||||||
| 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. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "Name": "Name", "Description": "Name", "PropertyGroupOrder": 3, "Section": 1, "Hidden": false "Responsive": 1 } |
|
||||||||||||||||||||
| Action: | GET ALL | |||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||
| URL: | /api/v1/static/onboardingpropertygroup/getall | |||||||||||||||||||||
| Description: | Fetch all Static Onboarding Property Group records 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 collection of Static Onboarding Property Group records. [{ "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "Name": "Name", "Description": "Name", "PropertyGroupOrder": 3, "Section": 1, "Hidden": false "Responsive": 1 }] |
|
||||||||||||||||||||
| Action: | ADD | |||||||||||||||||||||
| Method: | POST | |||||||||||||||||||||
| URL: | /api/v1/static/onboardingpropertygroup/add | |||||||||||||||||||||
| Description: | Add a Static Onboarding Property Group and link it 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 | Name | String | Name | |||||||||||||||||||
| Body | Description | String | Description | |||||||||||||||||||
| Body | PropertyGroupOrder | Int 32 | Order of the property group | |||||||||||||||||||
| Body | Section | Int 32 | 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 group 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 added. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52058, "Name": "Professional Details", "Description": "Professional Details", "PropertyGroupOrder": 2, "Section": 1, "Hidden": false "Responsive": 1 } |
|
||||||||||||||||||||
| Action: | UPDATE | |||||||||||||||||||||
| Method: | PUT | |||||||||||||||||||||
| URL: | /api/v1/static/onboardingpropertygroup/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 | Name | String | Name | |||||||||||||||||||
| Body | Description | String | Description | |||||||||||||||||||
| Body | PropertyGroupOrder | Int 32 | Order of the property group | |||||||||||||||||||
| Body | Section | Int 32 | 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 group 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": 52058, "Name": "Professional Details", "Description": "Professional Details", "PropertyGroupOrder": 2, "Section": 1, "Hidden": false "Responsive": 1 } |
|
||||||||||||||||||||
| Action: | DELETE | |||||||||||||||||||||
| Method: | DELETE | |||||||||||||||||||||
| URL: | /api/v1/static/onboardingpropertygroup/delete | |||||||||||||||||||||
| Description: | Delete an existing Static Onboarding Property Group and it's link with the Onboarding Type Identifer | |||||||||||||||||||||
| 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 | OnboardingPropertyGroupID | Int32 | Identifier of the Static Onboarding Property Group to delete | |||||||||||||||||||
| 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 deleted. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52058, "Name": "Professional Details", "Description": "Professional Details", "PropertyGroupOrder": 2, "Section": 1, "Hidden": false "Responsive": 1 } |
|
||||||||||||||||||||