BootView WebApi

<back to all web services

SaveCustomerPolicy

The following routes are available for this service:
POST/customers/{id}/policiesSave the eligibility policy for the given customer for the given policy type (there can be only one policy per type per customer). If the current user doesn't have access to this customer, the service returns an error. The current policy will be deleted and replced with the POSTed policy.
SaveCustomerPolicy Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer id.
PolicybodyCustomerPolicyYesThe policy. There can be only one policy per type for each customer, so this will replace the existing policy of the same type.
CustomerPolicy Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PolicyTypeformEligibilityTypeNo
AggregatorformEligibilityRuleSetAggregatorNo
RuleSetsformList<CustomerPolicy>No
RulesformList<Rule>No
Rule Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
RuleTypeformstringNo
RuleDataformRuleDataNo
RuleData Parameters:
NameParameterData TypeRequiredDescription
AlertTypeIdformint?No
AmountDueThresholdformdecimal?No
AmountPaidThresholdformdecimal?No
BillTypeIdformint?No
DocumentProofTypeIdformint?No
RuleTypeIdformintNo
RuleSetIdformintNo
LicenseStateformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /x-msgpack/reply/SaveCustomerPolicy HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"id":"00000000000000000000000000000000","policy":{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{}],"rules":[{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}}]}],"rules":[{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}}]}],"rules":[{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}}]}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

0