BokaMera.API.Host

<back to all web services

CreateCompanyCreditCard

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/billing/company/creditcardAdd a new credit card with Ticket Id from payment solution.Add new credit card from payment solution with their ticket id.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CompanyCreditCardQueryResponse() = 
        ///<summary>
        ///The credit card id
        ///</summary>
        [<ApiMember(Description="The credit card id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The credit card name
        ///</summary>
        [<ApiMember(Description="The credit card name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///If the credit card is active
        ///</summary>
        [<ApiMember(Description="If the credit card is active")>]
        member val Active:Boolean = new Boolean() with get,set

        ///<summary>
        ///If the credit card is valid (active and not expired)
        ///</summary>
        [<ApiMember(Description="If the credit card is valid (active and not expired)")>]
        member val IsValid:Boolean = new Boolean() with get,set

        ///<summary>
        ///The credit card type
        ///</summary>
        [<ApiMember(Description="The credit card type")>]
        member val Type:String = null with get,set

        ///<summary>
        ///The credit card expiration Year
        ///</summary>
        [<ApiMember(Description="The credit card expiration Year")>]
        member val ExpYear:String = null with get,set

        ///<summary>
        ///The credit card expiration month
        ///</summary>
        [<ApiMember(Description="The credit card expiration month")>]
        member val ExpMonth:String = null with get,set

        ///<summary>
        ///The credit card ticket name. This is secret information and won't be displayed
        ///</summary>
        [<ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")>]
        member val TicketId:String = null with get,set

        ///<summary>
        ///The date when the credit card was saved.
        ///</summary>
        [<ApiMember(Description="The date when the credit card was saved.")>]
        member val Created:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///The date when the credit card was updated.
        ///</summary>
        [<ApiMember(Description="The date when the credit card was updated.")>]
        member val Updated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type CreateCompanyCreditCard() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The credit card name
        ///</summary>
        [<ApiMember(Description="The credit card name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The credit card type. In example Mastercard, Visa
        ///</summary>
        [<ApiMember(Description="The credit card type. In example Mastercard, Visa")>]
        member val Type:String = null with get,set

        ///<summary>
        ///The credit card expiration Year
        ///</summary>
        [<ApiMember(Description="The credit card expiration Year")>]
        member val ExpYear:String = null with get,set

        ///<summary>
        ///The credit card expiration month
        ///</summary>
        [<ApiMember(Description="The credit card expiration month")>]
        member val ExpMonth:String = null with get,set

        ///<summary>
        ///The credit card ticket name. This is secret information and won't be displayed
        ///</summary>
        [<ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")>]
        member val TicketId:String = null with get,set

F# CreateCompanyCreditCard 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 /billing/company/creditcard HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCompanyCreditCard 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>
  <ExpMonth>String</ExpMonth>
  <ExpYear>String</ExpYear>
  <Name>String</Name>
  <TicketId>String</TicketId>
  <Type>String</Type>
</CreateCompanyCreditCard>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyCreditCardQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Created>0001-01-01T00:00:00</Created>
  <ExpMonth>String</ExpMonth>
  <ExpYear>String</ExpYear>
  <Id>0</Id>
  <IsValid>false</IsValid>
  <Name>String</Name>
  <TicketId>String</TicketId>
  <Type>String</Type>
  <Updated>0001-01-01T00:00:00</Updated>
</CompanyCreditCardQueryResponse>