BootView WebApi

<back to all web services

CreateEligibilityOverrideReason

Creates a new eligibility override reason for a given customer and eligibility type. Fails if either CustomerId or Eligibility Type are missing.
CreateEligibilityOverrideReason Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer Id.
TypequeryEligibilityTypeYes(SelfRelease | AssistedRelease). Throws exception if not provided.
DescriptionbodystringYesThe description for this eligibility override reason.
IsDeletedbodyboolYesWhether this eligibility override reason is deleted (inactive).
EligibilityType Enum:
Unkown
Notice
Boot
Tow
SelfRelease
AssistedRelease
CreateEligibilityOverrideReasonResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNo

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: CreateEligibilityOverrideReason

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<CreateEligibilityOverrideReason xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Description>String</Description>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsDeleted>false</IsDeleted>
  <Type>Unkown</Type>
</CreateEligibilityOverrideReason>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<CreateEligibilityOverrideReasonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>0</Id>
</CreateEligibilityOverrideReasonResult>

    </soap:Body>
</soap:Envelope>