| Action: | GET ALL RESTRICTIONS | |||||||||||
| Method: | GET | |||||||||||
| URL: | /api/v1/static/onboardingtypebusinessunitrestrictionlink/getallrestrictions | |||||||||||
| Description: | Fetch all Onboarding Type Business Unit restriction records for the client | |||||||||||
| Type | Key | DataType | Notes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||
| Return Data: |
Json or XML collection of Onboarding Type Business Unit restriction records. [{ "Id": 123, "OnboardingTypeId": 200, "BusinessUnitId": 5 }] |
|
||||||||||
| Action: | GET RESTRICTIONS BY BUSINESS UNIT | |||||||||||
| Method: | GET | |||||||||||
| URL: | /api/v1/static/onboardingtypebusinessunitrestrictionlink/getrestrictionsbybusinessunit | |||||||||||
| Description: | Fetch Onboarding Type Business Unit restriction records for a Business Unit | |||||||||||
| Type | Key | DataType | Notes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||
| Params | BusinessUnitId | Integer | Business Unit Identifier | |||||||||
| Return Data: |
Json or XML collection of Onboarding Type Business Unit restriction records. [{ "Id": 123, "OnboardingTypeId": 200, "BusinessUnitId": 5 }] |
|
||||||||||
| Action: | ADD RESTRICTION | |||||||||||
| Method: | POST | |||||||||||
| URL: | /api/v1/static/onboardingtypebusinessunitrestrictionlink/addrestriction | |||||||||||
| Description: | Add an Onboarding Type restriction to a Business Unit. If the restriction already exists, the existing record is returned. | |||||||||||
| Type | Key | DataType | Notes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||
| Body | BusinessUnitId | Integer | Business Unit Identifier | |||||||||
| Body | OnboardingTypeId | Integer | Onboarding Type Identifier | |||||||||
| Return Data: |
Json or XML of an Onboarding Type Business Unit restriction record. { "Id": 123, "OnboardingTypeId": 200, "BusinessUnitId": 5 } |
|
||||||||||
| Action: | DELETE RESTRICTION | |||
| Method: | DELETE | |||
| URL: | /api/v1/static/onboardingtypebusinessunitrestrictionlink/deleterestriction | |||
| Description: | Remove an Onboarding Type restriction from a Business Unit | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Body | ReturnFormat | String | Json or Xml | |
| Body | BusinessUnitId | Integer | Business Unit Identifier | |
| Body | OnboardingTypeId | Integer | Onboarding Type Identifier | |
| Return Data: |
204 No Content
|
|||