BokaMera.API.Host

TestQvicklyApiSettingsQuery

The following routes are available for this service:
POST	/payment/billmate/apisettings/test	Test Qvickly api settings	Test Qvickly api settings for the logged in company


export class QvicklyApiSettingsTestResponse
{
    /** @description If the settings works or not */
    // @ApiMember(Description="If the settings works or not")
    public Success: boolean;

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

// @ValidateRequest(Validator="IsAuthenticated")
export class TestQvicklyApiSettingsQuery 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")
    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<TestQvicklyApiSettingsQuery>) { (Object as any).assign(this, init); }
}

TypeScript TestQvicklyApiSettingsQuery DTOs

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

HTTP + XML

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

POST /payment/billmate/apisettings/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestQvicklyApiSettingsQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>0</Id>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <Secret>String</Secret>
</TestQvicklyApiSettingsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QvicklyApiSettingsTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Success>false</Success>
</QvicklyApiSettingsTestResponse>