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

export class QvicklyApiSettingsQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The Qvickly id */
    // @ApiMember(Description="The Qvickly id")
    public Id: number;

    /** @description The Qvickly secret */
    // @ApiMember(Description="The Qvickly secret")
    public Secret: string;

    /** @description The Qvickly receiver email */
    // @ApiMember(Description="The Qvickly receiver email")
    public ReceiverEmail: string;

    /** @description The Qvickly receiver firstname */
    // @ApiMember(Description="The Qvickly receiver firstname")
    public ReceiverFirstname: string;

    /** @description The Qvickly receiver lastname */
    // @ApiMember(Description="The Qvickly receiver lastname")
    public ReceiverLastname: string;

    public constructor(init?: Partial<QvicklyApiSettingsQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class AddQvicklyApiSettings implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description The Qvickly id */
    // @ApiMember(Description="The Qvickly id", IsRequired=true)
    public Id: number;

    /** @description The Qvickly secret */
    // @ApiMember(Description="The Qvickly secret", IsRequired=true)
    public Secret: string;

    /** @description The Qvickly receiver email */
    // @ApiMember(Description="The Qvickly receiver email", IsRequired=true)
    public ReceiverEmail: string;

    /** @description The Qvickly receiver firstname */
    // @ApiMember(Description="The Qvickly receiver firstname", IsRequired=true)
    public ReceiverFirstname: string;

    /** @description The Qvickly receiver lastname */
    // @ApiMember(Description="The Qvickly receiver lastname", IsRequired=true)
    public ReceiverLastname: string;

    public constructor(init?: Partial<AddQvicklyApiSettings>) { (Object as any).assign(this, init); }
}

TypeScript AddQvicklyApiSettings DTOs

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 /payment/billmate/apisettings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

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