| Action: | GET ALL | |||||||||||||
| Method: | GET | |||||||||||||
| URL: | /api/v1/static/onboardingriskband/all | |||||||||||||
| Description: | Fetch all Risk Band records | |||||||||||||
| Type | Key | DataType | Notes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||
| Return Data: |
Json or XML collection of Risk Band records. [{ "Id": 123, "OnboardingTypeId": 42, "Name": "Finance" "Order": 66 }] |
|
||||||||||||
| Action: | GET BY ID | |||||||||||||
| Method: | GET | |||||||||||||
| URL: | /api/v1/static/onboardingriskband | |||||||||||||
| Description: | Fetch Risk Band record by ID | |||||||||||||
| Type | Key | DataType | Notes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||
| Params | id | Integer | Risk Band ID | |||||||||||
| Return Data: |
Json or XML of a Risk Band record. { "Id": 123, "OnboardingTypeId": 42, "Name": "Finance" "Order": 66 } |
|
||||||||||||
| Action: | GET BY ONBOARDING TYPE | |||||||||||||
| Method: | GET | |||||||||||||
| URL: | /api/v1/static/onboardingriskband/onboardingtype | |||||||||||||
| Description: | Fetch all Risk Band records for specified Onboarding Type | |||||||||||||
| Type | Key | DataType | Notes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||
| Params | onboardingTypeId | Integer | Onboarding Type ID | |||||||||||
| Return Data: |
Json or XML collection of Risk Band records. [{ "Id": 123, "OnboardingTypeId": 42, "Name": "Finance" "Order": 66 }] |
|
||||||||||||
| Action: | CREATE | |||||||||||||
| Method: | POST | |||||||||||||
| URL: | /api/v1/static/onboardingriskband | |||||||||||||
| Description: | Create new Risk Band | |||||||||||||
| Type | Key | DataType | Notes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||
| Body | OnboardingTypeId | Integer | Onboarding Type ID | |||||||||||
| Body | Name | String | Name of new Risk Band | |||||||||||
| Body | Order | Integer | Order Risk Band will be displayed | |||||||||||
| Return Data: |
Json or XML of a Risk Band record. { "Id": 123, "OnboardingTypeId": 42, "Name": "Finance" "Order": 66 } |
|
||||||||||||
| Action: | UPDATE | |||||||||||||
| Method: | PUT | |||||||||||||
| URL: | /api/v1/static/onboardingriskband | |||||||||||||
| Description: | Update a Risk Band | |||||||||||||
| Type | Key | DataType | Notes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||
| Body | Id | Integer | Risk Band ID | |||||||||||
| Body | OnboardingTypeId | Integer | New Onboarding Type ID | |||||||||||
| Body | Name | String | New Name of new Risk Band | |||||||||||
| Body | Order | Integer | New Order Risk Band will be displayed | |||||||||||
| Return Data: |
Json or XML of a Risk Band record. { "Id": 123, "OnboardingTypeId": 42, "Name": "Finance" "Order": 66 } |
|
||||||||||||
| Action: | DELETE | |||
| Method: | DELETE | |||
| URL: | /api/v1/static/onboardingriskband | |||
| Description: | Delete a Risk Band | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Params | id | Integer | Risk Band ID | |
| Return Data: |
200 OK
|
|||