POST | /customers/{customerId}/partners/{partnerId} | Creates a new partner for this customer.The combination of customer id and partner id uniquely identifies this partner. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The Customer Id. |
PartnerId | path | Guid | Yes | The Partner Id. |
PartnerMunicipalityCode | body | string | Yes | The Municipality Code of the Partner. |
IsRealTimeBills | body | bool | Yes | Whether the Partner uses real time bills. |
IsRealTimeBoots | body | bool | Yes | Whether the Partner uses real time boots. |
ConnectionProfile | body | string | No | The connection profile of the Partner. |
dbprefix | body | string | No | The prefix in the database for the Partner. |
IsRealTimePayments | body | bool | Yes | Whether the Partner receives real time payments. |
LoadBootEligibleTicketsOnly | body | bool | Yes | Whether the Partner loads boot eligible tickets only. |
IsRealTimeReleases | body | bool | No | Whether the Partner uses real time releases. |
IsRealTimeTows | body | bool | No | Whether the Partner uses real time towing. |
IsRealTimeNotices | body | bool | No | Whether the Partner uses real time notices. |
IsRealTimeAddressUpdate | body | bool | No | Whether the Partner uses real time address updates. |
IsRealTimeTowDispatch | body | bool | No | Whether the Partner uses real time tow dispatch. |
IsRealTimeBootReturns | body | bool | No | Whether the Partner uses real time boot returns. |
IsRealTimePaymentPlan | body | bool | No | Whether the Partner uses real time payment plan. |
CanCreateBillsForFees | body | bool | Yes | Whether the Partner can create bills for fees. |
PartnerServices | body | List<CustomerPartnerService> | No | An array of objects representing the services of the partner. |
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 |
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.
POST /customers/{customerId}/partners/{partnerId} HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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:
[
{
partnerId: 00000000000000000000000000000000,
customerId: 00000000000000000000000000000000,
serviceName: String,
userId: String,
password: String
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length 00000000-0000-0000-0000-000000000000