GET | /customers/{id} | Gets a specific customer by customer Id. Only returns the customer if this user has access to. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The customer id |
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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 }