Action: | GET | |||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/propertyrisk/get | |||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Static Property Risk 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 | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyRuleUniqueID | Int32 | Onboarding Property Rule Unique Identifier | |||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Property Risk record. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52001, "OnboardingPropertyID": 51003, "UniqueID": 12345, "ListDataID": 34239, "IntegerStart": 0, "IntegerEnd": 0, "DecimalStart": 0.0000000000, "DecimalEnd": 0.0000000000, "DateOperator": 0, "DateMagnitude": 0, "DateTimespan": 0, "DateMode": 0, "DateSpecificdate": null, "RiskMarker": 25 "WeightedRiskScore": 0, "RiskFactorOverride": false, } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/propertyrisk/getall | |||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Property Risk records for an onboarding property | |||||||||||||||||||||||||||||||||||||||
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 | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Static Property Risk records. [{ "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52001, "OnboardingPropertyID": 51003, "UniqueID": 12345, "ListDataID": 34239, "IntegerStart": 0, "IntegerEnd": 0, "DecimalStart": 0.0000000000, "DecimalEnd": 0.0000000000, "DateOperator": 0, "DateMagnitude": 0, "DateTimespan": 0, "DateMode": 0, "DateSpecificdate": null, "RiskMarker": 25 "WeightedRiskScore": 0, "RiskFactorOverride": false, }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/propertyrisk/add | |||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Property Risk record | |||||||||||||||||||||||||||||||||||||||
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 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||
Body | ListDataID | Int32 | List Data Identifier | |||||||||||||||||||||||||||||||||||||
Body | IntegerStart | Int32 | Integer start value | |||||||||||||||||||||||||||||||||||||
Body | IntegerEnd | Int32 | Integer end value | |||||||||||||||||||||||||||||||||||||
Body | DecimalStart | Decimal | Decimal start value | |||||||||||||||||||||||||||||||||||||
Body | DecimalEnd | Decimal | Decimal end value | |||||||||||||||||||||||||||||||||||||
Body | DateOperator | Byte | Date Operator (0 = EqualTo, 1 = LessThan, 2 = GreaterThan, 3 = LessThanOREqualTo, 4 = GreaterThanOREqualTo) | |||||||||||||||||||||||||||||||||||||
Body | DateMagnitude | Int32 | Date Magnitude | |||||||||||||||||||||||||||||||||||||
Body | DateTimespan | Byte | Date Timespan (0 = Days, 1 = Weeks, 2 = Months, 3 = Quarters, 4 = Years, 5 = Decades) | |||||||||||||||||||||||||||||||||||||
Body | DateMode | Byte | Date Mode (0 = Blank, 1 = Today, 2 = SpecificDate) | |||||||||||||||||||||||||||||||||||||
Body | DateSpecificdate | Date | Specific Date | |||||||||||||||||||||||||||||||||||||
Body | RiskMarker | Byte | Risk | |||||||||||||||||||||||||||||||||||||
Body | WeightedRiskScore | Byte | Weighted Risk Score | |||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverride | Boolean | Risk Factor Override | |||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Property Risk record added. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52001, "OnboardingPropertyID": 51003, "UniqueID": 12345, "ListDataID": 34084, "IntegerStart": 0, "IntegerEnd": 0, "DecimalStart": 0.0000000000, "DecimalEnd": 0.0000000000, "DateOperator": 0, "DateMagnitude": 0, "DateTimespan": 0, "DateMode": 0, "DateSpecificdate": null, "RiskMarker": 40 "WeightedRiskScore": 0, "RiskFactorOverride": false, } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/propertyrisk/update | |||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Property Risk | |||||||||||||||||||||||||||||||||||||||
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 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||
Body | ListDataID | Int32 | List Data Identifier | |||||||||||||||||||||||||||||||||||||
Body | IntegerStart | Int32 | Integer start value | |||||||||||||||||||||||||||||||||||||
Body | IntegerEnd | Int32 | Integer end value | |||||||||||||||||||||||||||||||||||||
Body | DecimalStart | Decimal | Decimal start value | |||||||||||||||||||||||||||||||||||||
Body | DecimalEnd | Decimal | Decimal end value | |||||||||||||||||||||||||||||||||||||
Body | DateOperator | Byte | Date Operator (0 = EqualTo, 1 = LessThan, 2 = GreaterThan, 3 = LessThanOREqualTo, 4 = GreaterThanOREqualTo) | |||||||||||||||||||||||||||||||||||||
Body | DateMagnitude | Int32 | Date Magnitude | |||||||||||||||||||||||||||||||||||||
Body | DateTimespan | Byte | Date Timespan (0 = Days, 1 = Weeks, 2 = Months, 3 = Quarters, 4 = Years, 5 = Decades) | |||||||||||||||||||||||||||||||||||||
Body | DateMode | Byte | Date Mode (0 = Blank, 1 = Today, 2 = SpecificDate) | |||||||||||||||||||||||||||||||||||||
Body | DateSpecificdate | Date | Specific Date | |||||||||||||||||||||||||||||||||||||
Body | RiskMarker | Byte | Risk | |||||||||||||||||||||||||||||||||||||
Body | WeightedRiskScore | Byte | Weighted Risk Score | |||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverride | Boolean | Risk Factor Override | |||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Property Risk record updated. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52001, "OnboardingPropertyID": 51003, "UniqueID": 12345, "ListDataID": 34084, "IntegerStart": 0, "IntegerEnd": 0, "DecimalStart": 0.0000000000, "DecimalEnd": 0.0000000000, "DateOperator": 0, "DateMagnitude": 0, "DateTimespan": 0, "DateMode": 0, "DateSpecificdate": null, "RiskMarker": 40 "WeightedRiskScore": 0, "RiskFactorOverride": false, } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/propertyrisk/delete | |||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Property Risk record | |||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int32 | Onboarding Type Identifier | |||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyGroupID | Int32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyRuleUniqueID | Int32 | Onboarding Property Rule Unique Identifier | |||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Property Risk record deleted. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52001, "OnboardingPropertyID": 51003, "UniqueID": 12345, "ListDataID": 34084, "IntegerStart": 0, "IntegerEnd": 0, "DecimalStart": 0.0000000000, "DecimalEnd": 0.0000000000, "DateOperator": 0, "DateMagnitude": 0, "DateTimespan": 0, "DateMode": 0, "DateSpecificdate": null, "RiskMarker": 40 "WeightedRiskScore": 0, "RiskFactorOverride": false, } |
|