GET | /customers/{id}/policies | Find the eligibility policy for the given customer by policy type (there should be only one policy per type per customer). If the current user doesn't have access to this customer, or the policy doesn't exist, the service returns an error. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The customer id. |
PolicyType | query | EligibilityType | Yes | The policy type. There can be only one policy per type for each customer. |
Unkown |
Notice |
Boot |
Tow |
SelfRelease |
AssistedRelease |
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 |
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.
GET /customers/{id}/policies HTTP/1.1 Host: api.paylock.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":[{"id":0,"policyType":"Unkown","aggregator":"Unknown","ruleSets":null,"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"}}]}],"rules":[{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}}]}