BokaMera.API.Host

<back to all web services

PaysonApiSettingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/payment/payson/apisettingsGet payson api settingsGet payson api settings for the logged in company
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class PaysonApiSettingsQuery
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
        End Class

        Public Partial Class PaysonApiSettingsQueryResponse
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''The payson security user id
            '''</Summary>
            <ApiMember(Description:="The payson security user id")>
            Public Overridable Property SecurityUserId As String

            '''<Summary>
            '''The payson security user password
            '''</Summary>
            <ApiMember(Description:="The payson security user password")>
            Public Overridable Property SecurityPassword As String

            '''<Summary>
            '''The payson receiver email
            '''</Summary>
            <ApiMember(Description:="The payson receiver email")>
            Public Overridable Property ReceiverEmail As String

            '''<Summary>
            '''The payson receiver firstname
            '''</Summary>
            <ApiMember(Description:="The payson receiver firstname")>
            Public Overridable Property ReceiverFirstname As String

            '''<Summary>
            '''The payson receiver lastname
            '''</Summary>
            <ApiMember(Description:="The payson receiver lastname")>
            Public Overridable Property ReceiverLastname As String
        End Class
    End Namespace
End Namespace

VB.NET PaysonApiSettingsQuery DTOs

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.

GET /payment/payson/apisettings HTTP/1.1 
Host: api.bookmore.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SecurityUserId":"String","SecurityPassword":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}