BootView WebApi

<back to all web services

GetCustomerPolicy

The following routes are available for this service:
GET/customers/{id}/policiesFind 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.
GetCustomerPolicy Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer id.
PolicyTypequeryEligibilityTypeYesThe policy type. There can be only one policy per type for each customer.
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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/GetCustomerPolicy HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCustomerPolicy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <PolicyType>Unkown</PolicyType>
</GetCustomerPolicy>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerPolicy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Aggregator>Unknown</Aggregator>
  <Id>0</Id>
  <PolicyType>Unkown</PolicyType>
  <RuleSets>
    <CustomerPolicy>
      <Aggregator>Unknown</Aggregator>
      <Id>0</Id>
      <PolicyType>Unkown</PolicyType>
      <RuleSets>
        <CustomerPolicy>
          <Aggregator>Unknown</Aggregator>
          <Id>0</Id>
          <PolicyType>Unkown</PolicyType>
          <RuleSets>
            <CustomerPolicy>
              <Aggregator>Unknown</Aggregator>
              <Id>0</Id>
              <PolicyType>Unkown</PolicyType>
              <RuleSets i:nil="true" />
              <Rules>
                <Rule>
                  <Description>String</Description>
                  <Id>0</Id>
                  <RuleData>
                    <AlertTypeId>0</AlertTypeId>
                    <AmountDueThreshold>0</AmountDueThreshold>
                    <AmountPaidThreshold>0</AmountPaidThreshold>
                    <BillTypeId>0</BillTypeId>
                    <DocumentProofTypeId>0</DocumentProofTypeId>
                    <LicenseState>String</LicenseState>
                    <RuleSetId>0</RuleSetId>
                    <RuleTypeId>0</RuleTypeId>
                  </RuleData>
                  <RuleType>String</RuleType>
                </Rule>
              </Rules>
            </CustomerPolicy>
          </RuleSets>
          <Rules>
            <Rule>
              <Description>String</Description>
              <Id>0</Id>
              <RuleData>
                <AlertTypeId>0</AlertTypeId>
                <AmountDueThreshold>0</AmountDueThreshold>
                <AmountPaidThreshold>0</AmountPaidThreshold>
                <BillTypeId>0</BillTypeId>
                <DocumentProofTypeId>0</DocumentProofTypeId>
                <LicenseState>String</LicenseState>
                <RuleSetId>0</RuleSetId>
                <RuleTypeId>0</RuleTypeId>
              </RuleData>
              <RuleType>String</RuleType>
            </Rule>
          </Rules>
        </CustomerPolicy>
      </RuleSets>
      <Rules>
        <Rule>
          <Description>String</Description>
          <Id>0</Id>
          <RuleData>
            <AlertTypeId>0</AlertTypeId>
            <AmountDueThreshold>0</AmountDueThreshold>
            <AmountPaidThreshold>0</AmountPaidThreshold>
            <BillTypeId>0</BillTypeId>
            <DocumentProofTypeId>0</DocumentProofTypeId>
            <LicenseState>String</LicenseState>
            <RuleSetId>0</RuleSetId>
            <RuleTypeId>0</RuleTypeId>
          </RuleData>
          <RuleType>String</RuleType>
        </Rule>
      </Rules>
    </CustomerPolicy>
  </RuleSets>
  <Rules>
    <Rule>
      <Description>String</Description>
      <Id>0</Id>
      <RuleData>
        <AlertTypeId>0</AlertTypeId>
        <AmountDueThreshold>0</AmountDueThreshold>
        <AmountPaidThreshold>0</AmountPaidThreshold>
        <BillTypeId>0</BillTypeId>
        <DocumentProofTypeId>0</DocumentProofTypeId>
        <LicenseState>String</LicenseState>
        <RuleSetId>0</RuleSetId>
        <RuleTypeId>0</RuleTypeId>
      </RuleData>
      <RuleType>String</RuleType>
    </Rule>
  </Rules>
</CustomerPolicy>