BokaMera.API.Host

<back to all web services

TestPaysonApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/payson/apisettings/testTest payson api settingsTest payson api settings for the logged in company

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

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

// @ValidateRequest(Validator="IsAuthenticated")
export class TestPaysonApiSettings 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 payson security user id */
    // @ApiMember(Description="The payson security user id")
    public SecurityUserId: string;

    /** @description The payson security user password */
    // @ApiMember(Description="The payson security user password")
    public SecurityPassword: string;

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

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

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

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

TypeScript TestPaysonApiSettings 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/payson/apisettings/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestPaysonApiSettings 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>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <SecurityPassword>String</SecurityPassword>
  <SecurityUserId>String</SecurityUserId>
</TestPaysonApiSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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