| Action: | GET BY PROPERTY ID | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/conditionalunderride | |||||||||||||||
| Description: | Fetch all Conditional Underrides assigned to a Property | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||
| Params | PropertyId | Integer | Property ID | |||||||||||||
| Return Data: |
Json or XML collection of Risk Band records. [{ "Id": 123, "PropertyId": 42, "ConditionalPropertyId": 50 "ConditionalPropertyTargetValue": 54321 "ConditionalRiskScoreUnderrideValue": 50 }] |
|
||||||||||||||
| Action: | GET BY ID | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/conditionalunderride/getbyid | |||||||||||||||
| Description: | Fetch Conditional Underride | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||
| Params | UnderrideId | Integer | Underride ID | |||||||||||||
| Return Data: |
Json or XML collection of Risk Band records. { "Id": 123, "PropertyId": 42, "ConditionalPropertyId": 50 "ConditionalPropertyTargetValue": 54321 "ConditionalRiskScoreUnderrideValue": 50 } |
|
||||||||||||||
| Action: | GET BY ONBOARDING TYPE ID | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/conditionalunderride/getbyonboardingtype | |||||||||||||||
| Description: | Fetch all Conditional Underrides under an 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, "PropertyId": 42, "ConditionalPropertyId": 50 "ConditionalPropertyTargetValue": 54321 "ConditionalRiskScoreUnderrideValue": 50 }] |
|
||||||||||||||
| Action: | CREATE | |||||||||||||||
| Method: | POST | |||||||||||||||
| URL: | /api/v1/static/conditionalunderride | |||||||||||||||
| Description: | Create a Conditional Underride | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||
| Params | PropertyId | Integer | ID of Property the Conditional Underride is assigned to | |||||||||||||
| Params | ConditionalPropertyId | Integer | ID of sibling Property referenced in condition check | |||||||||||||
| Params | ConditionalPropertyTargetValue | Integer | ID of sibling Property's List Data item to meet condition | |||||||||||||
| Params | ConditionalRiskScoreUnderrideValue | Integer | Underride Risk Score if condition is met | |||||||||||||
| Return Data: |
Json or XML collection of Risk Band records. { "Id": 123, "PropertyId": 42, "ConditionalPropertyId": 50 "ConditionalPropertyTargetValue": 54321 "ConditionalRiskScoreUnderrideValue": 50 } |
|
||||||||||||||
| Action: | UPDATE | |||
| Method: | PUT | |||
| URL: | /api/v1/static/conditionalunderride | |||
| Description: | Update a Conditional Underride | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Params | ReturnFormat | String | Json or Xml | |
| Params | Id | Integer | ID of Conditional Underride to apply changes | |
| Params | PropertyId | Integer | New ID of Property the Conditional Underride is assigned to | |
| Params | ConditionalPropertyId | Integer | New ID of sibling Property referenced in condition check | |
| Params | ConditionalPropertyTargetValue | Integer | New ID of sibling Property's List Data item to meet condition | |
| Params | ConditionalRiskScoreUnderrideValue | Integer | New Underride Risk Score if condition is met | |
| Return Data: |
200 OK
|
|||
| Action: | DELETE | |||
| Method: | DELETE | |||
| URL: | /api/v1/static/conditionalunderride | |||
| Description: | Delete a Conditional Underride | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Params | ReturnFormat | String | Json or Xml | |
| Params | Id | Integer | ID of Conditional Underride to delete | |
| Params | PropertyId | Integer | ID of Property the Conditional Underride is assigned to (can be set to 0) | |
| Params | ConditionalPropertyId | Integer | ID of sibling Property referenced in condition check (can be set to 0) | |
| Params | ConditionalPropertyTargetValue | Integer | ID of sibling Property's List Data item to meet condition (can be set to 0) | |
| Params | ConditionalRiskScoreUnderrideValue | Integer | Underride Risk Score if condition is met (can be set to 0) | |
| Return Data: |
200 OK
|
|||