BootView WebApi

<back to all web services

GetCustomer

The following routes are available for this service:
GET/customers/{id}Gets a specific customer by customer Id. Only returns the customer if this user has access to.
GetCustomer Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer id
UserCustomer Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
CodeformstringNo
IsActiveformboolNo
UsePreventReleaseformboolNo
PreventReleasePromptformstringNo
PreventReleaseReasonformstringNo
AllowPaymentDuringTowformstringNo
PaymentRuleformintNo
ParkingviewSubDomainformstringNo
ParkingviewClientSubDomainformstringNo
AllowsMandatoryAssistedReleaseformboolNo
HotlistVehicleDebtDetailformboolNo
HotlistVehicleDebtSummaryformboolNo
AssistingReleaseAvailabilityformstringNo
AttributesformIEnumerable<Municipality_Attribute>No
Municipality_Attribute Parameters:
NameParameterData TypeRequiredDescription
Municipality_Attributes_IdformGuidNo
Municipality_IdformGuidNo
Att_NameformstringNo
Att_ValueformstringNo
Att_DescriptionformstringNo

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.

GET /customers/{id} HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AllowPaymentDuringTow>String</AllowPaymentDuringTow>
  <AllowsMandatoryAssistedRelease>false</AllowsMandatoryAssistedRelease>
  <AssistingReleaseAvailability>String</AssistingReleaseAvailability>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/PayLock.BootView.Pocos" i:nil="true" />
  <Code>String</Code>
  <HotlistVehicleDebtDetail>false</HotlistVehicleDebtDetail>
  <HotlistVehicleDebtSummary>false</HotlistVehicleDebtSummary>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsActive>false</IsActive>
  <Name>String</Name>
  <ParkingviewClientSubDomain>String</ParkingviewClientSubDomain>
  <ParkingviewSubDomain>String</ParkingviewSubDomain>
  <PaymentRule>0</PaymentRule>
  <PreventReleasePrompt>String</PreventReleasePrompt>
  <PreventReleaseReason>String</PreventReleaseReason>
  <UsePreventRelease>false</UsePreventRelease>
</UserCustomer>