POST | /customers/{id}/policies | Save 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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The customer id. |
Policy | body | CustomerPolicy | Yes | The policy. There can be only one policy per type for each customer, so this will replace the existing policy of the same type. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
PolicyType | form | EligibilityType | No | |
Aggregator | form | EligibilityRuleSetAggregator | No | |
RuleSets | form | List<CustomerPolicy> | No | |
Rules | form | List<Rule> | No |
Unkown |
Notice |
Boot |
Tow |
SelfRelease |
AssistedRelease |
Unknown |
All |
Any |
None |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Description | form | string | No | |
RuleType | form | string | No | |
RuleData | form | RuleData | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AlertTypeId | form | int? | No | |
AmountDueThreshold | form | decimal? | No | |
AmountPaidThreshold | form | decimal? | No | |
BillTypeId | form | int? | No | |
DocumentProofTypeId | form | int? | No | |
RuleTypeId | form | int | No | |
RuleSetId | form | int | No | |
LicenseState | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{id}/policies HTTP/1.1
Host: api.paylock.com
Accept: application/json
Content-Type: application/json
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/json Content-Length: length 0