BokaMera.API.Host

<back to all web services

AddQvicklyApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/billmate/apisettingsAdd Qvickly api settingsAdd Qvickly api settings for the logged in company
AddQvicklyApiSettings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdbodyintYesThe Qvickly id
SecretbodystringYesThe Qvickly secret
ReceiverEmailbodystringYesThe Qvickly receiver email
ReceiverFirstnamebodystringYesThe Qvickly receiver firstname
ReceiverLastnamebodystringYesThe Qvickly receiver lastname
QvicklyApiSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
IdformintNoThe Qvickly id
SecretformstringNoThe Qvickly secret
ReceiverEmailformstringNoThe Qvickly receiver email
ReceiverFirstnameformstringNoThe Qvickly receiver firstname
ReceiverLastnameformstringNoThe Qvickly receiver lastname

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/billmate/apisettings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Secret":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Secret":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}