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).
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /customers/{id}/eligibilityoverridereasons/ HTTP/1.1 
Host: api.paylock.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000,
	type: Unkown,
	description: String,
	isDeleted: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}