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
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

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 /jsv/reply/GetCustomerPartners HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	partnerId: 00000000000000000000000000000000,
	customerId: 00000000000000000000000000000000,
	partnerMunicipalityCode: String,
	isRealTimeBills: False,
	isRealTimeBoots: False,
	connectionProfile: String,
	dbPrefix: String,
	isRealTimePayments: False,
	loadBootEligibleTicketsOnly: False,
	isRealTimeReleases: False,
	isRealTimeTows: False,
	isRealTimeNotices: False,
	isRealTimeAddressUpdate: False,
	isRealTimeTowDispatch: False,
	canCreateBillsForFees: False,
	partnerServices: 
	[
		{
			id: 00000000000000000000000000000000,
			partnerId: 00000000000000000000000000000000,
			customerId: 00000000000000000000000000000000,
			serviceName: String,
			userId: String,
			password: String
		}
	],
	partnerDetail: 
	{
		partnerId: 00000000000000000000000000000000,
		partnerCode: String,
		partnerName: String,
		outboundUrl: String,
		outboundUserName: String,
		inboundUserName: String
	},
	customerDetail: 
	{
		id: 00000000000000000000000000000000,
		name: String,
		code: String,
		isActive: False,
		usePreventRelease: False,
		preventReleasePrompt: String,
		preventReleaseReason: String,
		allowPaymentDuringTow: String
	}
}