BokaMera.API.Host

<back to all web services

UpdatePaysonApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/payment/payson/apisettings/Update payson api settingsUpdate payson api settings for the logged in company
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class UpdatePaysonApiSettings : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * The payson security user id
    */
    @ApiMember(Description="The payson security user id")
    var SecurityUserId:String? = null

    /**
    * The payson security user password
    */
    @ApiMember(Description="The payson security user password")
    var SecurityPassword:String? = null

    /**
    * The payson receiver email
    */
    @ApiMember(Description="The payson receiver email")
    var ReceiverEmail:String? = null

    /**
    * The payson receiver firstname
    */
    @ApiMember(Description="The payson receiver firstname")
    var ReceiverFirstname:String? = null

    /**
    * The payson receiver lastname
    */
    @ApiMember(Description="The payson receiver lastname")
    var ReceiverLastname:String? = null
}

open class PaysonApiSettingsQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    var CompanyId:UUID? = null

    /**
    * The payson security user id
    */
    @ApiMember(Description="The payson security user id")
    var SecurityUserId:String? = null

    /**
    * The payson security user password
    */
    @ApiMember(Description="The payson security user password")
    var SecurityPassword:String? = null

    /**
    * The payson receiver email
    */
    @ApiMember(Description="The payson receiver email")
    var ReceiverEmail:String? = null

    /**
    * The payson receiver firstname
    */
    @ApiMember(Description="The payson receiver firstname")
    var ReceiverFirstname:String? = null

    /**
    * The payson receiver lastname
    */
    @ApiMember(Description="The payson receiver lastname")
    var ReceiverLastname:String? = null
}

Kotlin UpdatePaysonApiSettings 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.

PUT /payment/payson/apisettings/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdatePaysonApiSettings 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>
</UpdatePaysonApiSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaysonApiSettingsQueryResponse 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>
</PaysonApiSettingsQueryResponse>