| POST | /api/PostServiceTicket |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Namespace Global
Namespace AIM.WebService
<DataContract>
Public Partial Class BaseRequest
'''<Summary>
'''This is your AIM API Key provided by Tri-Tech
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="This is your AIM API Key provided by Tri-Tech", IsRequired:=true, Name:="ApiKey", ParameterType:="header")>
Public Overridable Property ApiKey As String
<DataMember>
<ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
Public Overridable Property OAuthToken As String
End Class
<DataContract>
Public Partial Class BaseResponse
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
Public Overridable Property Status As BaseResponseResult
<DataContract>
Public Partial Class BaseResponseResult
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
Public Overridable Property StatusCode As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
Public Overridable Property Login As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
Public Overridable Property ErrorCode As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
Public Overridable Property ErrorDisplayText As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
Public Overridable Property ErrorMessage As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
Public Overridable Property DomainName As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
Public Overridable Property IpAddress As String
End Class
End Class
<DataContract>
Public Partial Class BaseSecureRequest
Inherits BaseRequest
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
Public Overridable Property Token As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
Public Overridable Property DeviceId As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
Public Overridable Property AppId As String
End Class
<DataContract(Name:="CCInfo")>
Public Partial Class CcInfo
'''<Summary>
'''Token returned from processor
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Token returned from processor", IsRequired:=true, Name:="TokenStr", ParameterType:="query")>
Public Overridable Property TokenStr As String
'''<Summary>
'''Card Type (VISA, MCARD, AMEX, DSCVR)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired:=true, Name:="CardType", ParameterType:="query")>
Public Overridable Property CardType As String
'''<Summary>
'''Last four of the card
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Last four of the card", IsRequired:=true, Name:="LastFour", ParameterType:="query")>
Public Overridable Property LastFour As String
'''<Summary>
'''Expiration Date of the Card. (MM/YY)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Expiration Date of the Card. (MM/YY)", Name:="Expiration", ParameterType:="query")>
Public Overridable Property Expiration As String
'''<Summary>
'''Reason the card is on file.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Reason the card is on file.", Name:="ReasonOnFile", ParameterType:="query")>
Public Overridable Property ReasonOnFile As String
'''<Summary>
'''ID of the existing Token Record in AIM, if applicable
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="ID of the existing Token Record in AIM, if applicable", Format:="int64", Name:="TokenPk", ParameterType:="query")>
Public Overridable Property TokenPk As Nullable(Of Long)
'''<Summary>
'''Is this the customer's primary card? Defaults to false.
'''</Summary>
<DataMember>
<ApiMember(DataType:="boolean", Description:="Is this the customer's primary card? Defaults to false.", Name:="Primary", ParameterType:="query")>
Public Overridable Property Primary As Nullable(Of Boolean)
End Class
<DataContract(Name:="CustomerInfo")>
Public Partial Class CustomerInfo
'''<Summary>
'''The WebId of the customer. Optional.
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="The WebId of the customer. Optional.", Format:="int32", IsRequired:=true, Name:="WebId", ParameterType:="query")>
Public Overridable Property WebId As Nullable(Of Integer)
'''<Summary>
'''Name of the customer.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Name of the customer.", IsRequired:=true, Name:="Name", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''Address line 1 of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Address line 1 of the customer", Name:="Addr1", ParameterType:="query")>
Public Overridable Property Addr1 As String
'''<Summary>
'''Address line 2 of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Address line 2 of the customer", Name:="Addr2", ParameterType:="query")>
Public Overridable Property Addr2 As String
'''<Summary>
'''City of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="City of the customer", Name:="City", ParameterType:="query")>
Public Overridable Property City As String
'''<Summary>
'''State/Province of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="State/Province of the customer", Name:="St", ParameterType:="query")>
Public Overridable Property St As String
'''<Summary>
'''Zip code of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Zip code of the customer", Name:="Zip", ParameterType:="query")>
Public Overridable Property Zip As String
'''<Summary>
'''Country of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Country of the customer", Name:="Country", ParameterType:="query")>
Public Overridable Property Country As String
'''<Summary>
'''Phone number of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Phone number of the customer", Name:="Phone", ParameterType:="query")>
Public Overridable Property Phone As String
'''<Summary>
'''Email address of the customer. Required.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Email address of the customer. Required.", IsRequired:=true, Name:="Email", ParameterType:="query")>
Public Overridable Property Email As String
End Class
<DataContract(Name:="FormInput")>
Public Partial Class FormInput
'''<Summary>
'''Field Name of the Input Field
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Field Name of the Input Field", IsRequired:=true, Name:="Key", ParameterType:="query")>
Public Overridable Property Key As String
'''<Summary>
'''Value of the Input Field.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="query")>
Public Overridable Property Value As String
'''<Summary>
'''Whether or not the field is encryped with the C2B encryption key.
'''</Summary>
<DataMember>
<ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", IsRequired:=true, Name:="Encrypted", ParameterType:="query")>
Public Overridable Property Encrypted As Boolean
End Class
'''<Summary>
'''PostServiceTicketRequires active-e Service Tickets Service
'''</Summary>
<DataContract>
Public Partial Class PostServiceTicketRequest
Inherits BaseSecureRequest
Public Sub New()
FormInputList = New List(Of FormInput)
End Sub
'''<Summary>
'''Online reference number of this appointment
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Online reference number of this appointment", Name:="RefNumber", ParameterType:="query")>
Public Overridable Property RefNumber As String
'''<Summary>
'''Serial number of the item to be serviced
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Serial number of the item to be serviced", Name:="SerialNumber", ParameterType:="query")>
Public Overridable Property SerialNumber As String
'''<Summary>
'''The AIM customer account # of the customer. Optional.
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="The AIM customer account # of the customer. Optional.", Format:="int32", Name:="CustomerAcct", ParameterType:="query")>
Public Overridable Property CustomerAcct As Nullable(Of Integer)
'''<Summary>
'''Customer Information
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="Customer Information", Name:="CustomerInfo", ParameterType:="query")>
Public Overridable Property CustomerInfo As CustomerInfo
'''<Summary>
'''Additional Customer or Appointment info
'''</Summary>
<DataMember>
<ApiMember(DataType:="array", Description:="Additional Customer or Appointment info", Name:="FormInputList", ParameterType:="query")>
Public Overridable Property FormInputList As List(Of FormInput)
'''<Summary>
'''Credit Card info of the customer for this appointment
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="Credit Card info of the customer for this appointment", Name:="CcInfo", ParameterType:="query")>
Public Overridable Property CcInfo As CcInfo
'''<Summary>
'''Notes on this appointment
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Notes on this appointment", Name:="Notes", ParameterType:="query")>
Public Overridable Property Notes As String
<DataMember>
Public Overridable Property VoiceRecording As String
'''<Summary>
'''Description of the item to be serviced
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Description of the item to be serviced", Name:="ItemDescription", ParameterType:="query")>
Public Overridable Property ItemDescription As String
End Class
<DataContract>
Public Partial Class PostServiceTicketResponse
Inherits BaseResponse
<DataMember>
Public Overridable Property WebRef As String
End Class
End Namespace
End Namespace
VB.NET PostServiceTicketRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/PostServiceTicket HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"RefNumber":"String","SerialNumber":"String","CustomerAcct":0,"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"Notes":"String","VoiceRecording":"String","ItemDescription":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"WebRef":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}