BootView WebApi

<back to all web services

GetCustomerPartners

The following routes are available for this service:
GET/customers/{customerId}/partnersGets the partners for a given customer.
GetCustomerPartners Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer Id.
CustomerPartner Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformGuidNo
CustomerIdformGuidNo
PartnerMunicipalityCodeformstringNo
IsRealTimeBillsformboolNo
IsRealTimeBootsformboolNo
ConnectionProfileformstringNo
DbPrefixformstringNo
IsRealTimePaymentsformboolNo
LoadBootEligibleTicketsOnlyformboolNo
IsRealTimeReleasesformboolNo
IsRealTimeTowsformboolNo
IsRealTimeNoticesformboolNo
IsRealTimeAddressUpdateformboolNo
IsRealTimeTowDispatchformboolNo
IsRealTimeBootReturnsformboolNo
IsRealTimePaymentPlanformboolNo
CanCreateBillsForFeesformboolNo
PartnerServicesformList<CustomerPartnerService>No
PartnerDetailformCustomerPartnerDetailNo
CustomerDetailformUserCustomerNo
CustomerPartnerService Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PartnerIdformGuid?No
CustomerIdformGuid?No
ServiceNameformstringNo
UserIdformstringNo
PasswordformstringNo
CustomerPartnerDetail Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformGuidNo
PartnerCodeformstringNo
PartnerNameformstringNo
OutboundUrlformstringNo
OutboundUserNameformstringNo
InboundUserNameformstringNo
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/{customerId}/partners HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerPartner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CanCreateBillsForFees>false</CanCreateBillsForFees>
  <ConnectionProfile>String</ConnectionProfile>
  <CustomerDetail>
    <AllowPaymentDuringTow>String</AllowPaymentDuringTow>
    <AllowsMandatoryAssistedRelease>false</AllowsMandatoryAssistedRelease>
    <AssistingReleaseAvailability>String</AssistingReleaseAvailability>
    <Attributes xmlns:d3p1="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>
  </CustomerDetail>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <DbPrefix>String</DbPrefix>
  <IsRealTimeAddressUpdate>false</IsRealTimeAddressUpdate>
  <IsRealTimeBills>false</IsRealTimeBills>
  <IsRealTimeBootReturns>false</IsRealTimeBootReturns>
  <IsRealTimeBoots>false</IsRealTimeBoots>
  <IsRealTimeNotices>false</IsRealTimeNotices>
  <IsRealTimePaymentPlan>false</IsRealTimePaymentPlan>
  <IsRealTimePayments>false</IsRealTimePayments>
  <IsRealTimeReleases>false</IsRealTimeReleases>
  <IsRealTimeTowDispatch>false</IsRealTimeTowDispatch>
  <IsRealTimeTows>false</IsRealTimeTows>
  <LoadBootEligibleTicketsOnly>false</LoadBootEligibleTicketsOnly>
  <PartnerDetail>
    <InboundUserName>String</InboundUserName>
    <OutboundUrl>String</OutboundUrl>
    <OutboundUserName>String</OutboundUserName>
    <PartnerCode>String</PartnerCode>
    <PartnerId>00000000-0000-0000-0000-000000000000</PartnerId>
    <PartnerName>String</PartnerName>
  </PartnerDetail>
  <PartnerId>00000000-0000-0000-0000-000000000000</PartnerId>
  <PartnerMunicipalityCode>String</PartnerMunicipalityCode>
  <PartnerServices>
    <CustomerPartnerService>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <PartnerId>00000000-0000-0000-0000-000000000000</PartnerId>
      <Password>String</Password>
      <ServiceName>String</ServiceName>
      <UserId>String</UserId>
    </CustomerPartnerService>
  </PartnerServices>
</CustomerPartner>