POST | /sales/member/{MemberId}/payment/makepayment | Make a Payment for a Member |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Sales.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api
Namespace Global
Namespace ClubReady.Core.Api.Models
Public Partial Class ApiDtoBase
Public Overridable Property ApiKey As String
Public Overridable Property StoreId As Nullable(Of Integer)
Public Overridable Property ChainId As Nullable(Of Integer)
End Class
Public Partial Class MakePaymentRequest
Inherits ApiDtoBase
Public Sub New()
Invoice = New Integer(){}
End Sub
Public Overridable Property UserId As Integer
Public Overridable Property Amount As Decimal
Public Overridable Property Invoice As Integer()
End Class
End Namespace
Namespace ClubReady.Web.Api
Public Enum RestrictedResourceType
Store
Chain
User
Undefined
End Enum
End Namespace
Namespace ClubReady.Web.Api.Sales.Model
Public Partial Class MakePayment
Inherits MakePaymentRequest
Implements IRestrictedApiRequest
Public Sub New()
Invoice = New Integer(){}
End Sub
'''<Summary>
'''Api Key - grants access to resources
'''</Summary>
<ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
Public Overridable Property ApiKey As String
'''<Summary>
'''ID # of store member belongs to
'''</Summary>
<ApiMember(DataType:="integer", Description:="ID # of store member belongs to", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
Public Overridable Property StoreId As Nullable(Of Integer)
'''<Summary>
'''ID # of chain member belongs to
'''</Summary>
<ApiMember(DataType:="integer", Description:="ID # of chain member belongs to", Name:="ChainId", ParameterType:="query")>
Public Overridable Property ChainId As Nullable(Of Integer)
'''<Summary>
'''Member ID of user to make payment for
'''</Summary>
<ApiMember(DataType:="integer", Description:="Member ID of user to make payment for", IsRequired:=true, Name:="MemberId", ParameterType:="path")>
Public Overridable Property MemberId As Integer
'''<Summary>
'''Amount of the payment, including sales tax
'''</Summary>
<ApiMember(DataType:="decimal", Description:="Amount of the payment, including sales tax", IsRequired:=true, Name:="Amount", ParameterType:="query")>
Public Overridable Property Amount As Decimal
'''<Summary>
'''Invoice ID to be paid
'''</Summary>
<ApiMember(DataType:="integer", Description:="Invoice ID to be paid", IsRequired:=true, Name:="Invoice", ParameterType:="query")>
Public Overridable Property Invoice As Integer()
Public Overridable Property RestrictedId As Nullable(Of Integer)
Public Overridable Property RestrictedResourceType As RestrictedResourceType
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/member/{MemberId}/payment/makepayment HTTP/1.1
Host: clubready.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApiKey":"String","StoreId":0,"ChainId":0,"MemberId":0,"Amount":0,"Invoice":[0],"RestrictedId":0,"RestrictedResourceType":"Chain","UserId":0}