BootView WebApi

<back to all web services

CreateEligibilityOverrideReason

The following routes are available for this service:
POST/customers/{id}/eligibilityoverridereasons/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).
CreateEligibilityOverrideReasonResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNo

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/CreateEligibilityOverrideReason HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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