BootView WebApi

<back to all web services

CreateCustomerPartner

The following routes are available for this service:
POST/customers/{customerId}/partners/{partnerId}Creates a new partner for this customer.The combination of customer id and partner id uniquely identifies this partner.
CreateCustomerPartner Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
PartnerIdpathGuidYesThe Partner Id.
PartnerMunicipalityCodebodystringYesThe Municipality Code of the Partner.
IsRealTimeBillsbodyboolYesWhether the Partner uses real time bills.
IsRealTimeBootsbodyboolYesWhether the Partner uses real time boots.
ConnectionProfilebodystringNoThe connection profile of the Partner.
dbprefixbodystringNoThe prefix in the database for the Partner.
IsRealTimePaymentsbodyboolYesWhether the Partner receives real time payments.
LoadBootEligibleTicketsOnlybodyboolYesWhether the Partner loads boot eligible tickets only.
IsRealTimeReleasesbodyboolNoWhether the Partner uses real time releases.
IsRealTimeTowsbodyboolNoWhether the Partner uses real time towing.
IsRealTimeNoticesbodyboolNoWhether the Partner uses real time notices.
IsRealTimeAddressUpdatebodyboolNoWhether the Partner uses real time address updates.
IsRealTimeTowDispatchbodyboolNoWhether the Partner uses real time tow dispatch.
CanCreateBillsForFeesbodyboolYesWhether the Partner can create bills for fees.
PartnerServicesbodyList<CustomerPartnerService>NoAn array of objects representing the services of the partner.
CustomerPartnerService Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PartnerIdformGuid?No
CustomerIdformGuid?No
ServiceNameformstringNo
UserIdformstringNo
PasswordformstringNo

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

<CreateCustomerPartner 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>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <IsRealTimeAddressUpdate>false</IsRealTimeAddressUpdate>
  <IsRealTimeBills>false</IsRealTimeBills>
  <IsRealTimeBoots>false</IsRealTimeBoots>
  <IsRealTimeNotices>false</IsRealTimeNotices>
  <IsRealTimePayments>false</IsRealTimePayments>
  <IsRealTimeReleases>false</IsRealTimeReleases>
  <IsRealTimeTowDispatch>false</IsRealTimeTowDispatch>
  <IsRealTimeTows>false</IsRealTimeTows>
  <LoadBootEligibleTicketsOnly>false</LoadBootEligibleTicketsOnly>
  <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>
  <dbprefix>String</dbprefix>
</CreateCustomerPartner>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>