BootView WebApi

<back to all web services

CreatePartner

The following routes are available for this service:
POST/partnersCreates a new partner. Fails if Partner Name is missing.
CreatePartner Parameters:
NameParameterData TypeRequiredDescription
PartnerCodebodystringYesThe partner code.
PartnerNamebodystringYesThe partner name.
OutboundUserNamebodystringNoThe outbound username for this partner.
OutboundPasswordbodystringNoThe outbound password for this partner.
OutboundUrlbodystringNoThe outbound url for this partner.
InboundUserNamebodystringNoThe inbound username for this partner.
InboundPasswordbodystringNoThe inbound password for this partner.
CreatePartnerResult Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo

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

{
	partnerCode: String,
	partnerName: String,
	outboundUserName: String,
	outboundPassword: String,
	outboundUrl: String,
	inboundUserName: String,
	inboundPassword: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000
}