| GET | /customers/{customerId}/partners | Gets the partners for a given customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | Guid | Yes | The customer Id. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartnerId | form | Guid | No | |
| CustomerId | form | Guid | No | |
| PartnerMunicipalityCode | form | string | No | |
| IsRealTimeBills | form | bool | No | |
| IsRealTimeBoots | form | bool | No | |
| ConnectionProfile | form | string | No | |
| DbPrefix | form | string | No | |
| IsRealTimePayments | form | bool | No | |
| LoadBootEligibleTicketsOnly | form | bool | No | |
| IsRealTimeReleases | form | bool | No | |
| IsRealTimeTows | form | bool | No | |
| IsRealTimeNotices | form | bool | No | |
| IsRealTimeAddressUpdate | form | bool | No | |
| IsRealTimeTowDispatch | form | bool | No | |
| IsRealTimeBootReturns | form | bool | No | |
| IsRealTimePaymentPlan | form | bool | No | |
| CanCreateBillsForFees | form | bool | No | |
| PartnerServices | form | List<CustomerPartnerService> | No | |
| PartnerDetail | form | CustomerPartnerDetail | No | |
| CustomerDetail | form | UserCustomer | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| PartnerId | form | Guid? | No | |
| CustomerId | form | Guid? | No | |
| ServiceName | form | string | No | |
| UserId | form | string | No | |
| Password | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartnerId | form | Guid | No | |
| PartnerCode | form | string | No | |
| PartnerName | form | string | No | |
| OutboundUrl | form | string | No | |
| OutboundUserName | form | string | No | |
| InboundUserName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Code | form | string | No | |
| IsActive | form | bool | No | |
| UsePreventRelease | form | bool | No | |
| PreventReleasePrompt | form | string | No | |
| PreventReleaseReason | form | string | No | |
| AllowPaymentDuringTow | form | string | No | |
| PaymentRule | form | int | No | |
| ParkingviewSubDomain | form | string | No | |
| ParkingviewClientSubDomain | form | string | No | |
| AllowsMandatoryAssistedRelease | form | bool | No | |
| HotlistVehicleDebtDetail | form | bool | No | |
| HotlistVehicleDebtSummary | form | bool | No | |
| AssistingReleaseAvailability | form | string | No | |
| Attributes | form | IEnumerable<Municipality_Attribute> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Municipality_Attributes_Id | form | Guid | No | |
| Municipality_Id | form | Guid | No | |
| Att_Name | form | string | No | |
| Att_Value | form | string | No | |
| Att_Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
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,"isRealTimeBootReturns":false,"isRealTimePaymentPlan":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","paymentRule":0,"parkingviewSubDomain":"String","parkingviewClientSubDomain":"String","allowsMandatoryAssistedRelease":false,"hotlistVehicleDebtDetail":false,"hotlistVehicleDebtSummary":false,"assistingReleaseAvailability":"String","attributes":null}}