| POST | /api/PostServiceTicket |
|---|
namespace AIM.WebService
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponseResult() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
member val StatusCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
member val Login:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
member val ErrorCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
member val ErrorDisplayText:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
member val ErrorMessage:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
member val DomainName:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
member val IpAddress:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
member val Status:BaseResponseResult = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type PostServiceTicketResponse() =
inherit BaseResponse()
[<DataMember>]
member val WebRef:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiKey:String = null with get,set
[<DataMember>]
[<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
member val OAuthToken:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseSecureRequest() =
inherit BaseRequest()
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
member val Token:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
member val DeviceId:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
member val AppId:String = null with get,set
[<DataContract(Name="CustomerInfo")>]
[<AllowNullLiteral>]
type 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")>]
member val WebId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Name of the customer.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Address line 1 of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")>]
member val Addr1:String = null with get,set
///<summary>
///Address line 2 of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")>]
member val Addr2:String = null with get,set
///<summary>
///City of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")>]
member val City:String = null with get,set
///<summary>
///State/Province of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")>]
member val St:String = null with get,set
///<summary>
///Zip code of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")>]
member val Zip:String = null with get,set
///<summary>
///Country of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")>]
member val Country:String = null with get,set
///<summary>
///Phone number of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")>]
member val Phone:String = null with get,set
///<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")>]
member val Email:String = null with get,set
[<DataContract(Name="FormInput")>]
[<AllowNullLiteral>]
type 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")>]
member val Key:String = null with get,set
///<summary>
///Value of the Input Field.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")>]
member val Value:String = null with get,set
///<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")>]
member val Encrypted:Boolean = new Boolean() with get,set
[<DataContract(Name="CCInfo")>]
[<AllowNullLiteral>]
type CcInfo() =
///<summary>
///Token returned from processor
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")>]
member val TokenStr:String = null with get,set
///<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")>]
member val CardType:String = null with get,set
///<summary>
///Last four of the card
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")>]
member val LastFour:String = null with get,set
///<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")>]
member val Expiration:String = null with get,set
///<summary>
///Reason the card is on file.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")>]
member val ReasonOnFile:String = null with get,set
///<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")>]
member val TokenPk:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val Primary:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///PostServiceTicketRequires active-e Service Tickets Service
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type PostServiceTicketRequest() =
inherit BaseSecureRequest()
///<summary>
///Online reference number of this appointment
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Online reference number of this appointment", Name="RefNumber", ParameterType="query")>]
member val RefNumber:String = null with get,set
///<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")>]
member val SerialNumber:String = null with get,set
///<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")>]
member val CustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Customer Information
///</summary>
[<DataMember>]
[<ApiMember(DataType="object", Description="Customer Information", Name="CustomerInfo", ParameterType="query")>]
member val CustomerInfo:CustomerInfo = null with get,set
///<summary>
///Additional Customer or Appointment info
///</summary>
[<DataMember>]
[<ApiMember(DataType="array", Description="Additional Customer or Appointment info", Name="FormInputList", ParameterType="query")>]
member val FormInputList:ResizeArray<FormInput> = new ResizeArray<FormInput>() with get,set
///<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")>]
member val CcInfo:CcInfo = null with get,set
///<summary>
///Notes on this appointment
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Notes on this appointment", Name="Notes", ParameterType="query")>]
member val Notes:String = null with get,set
[<DataMember>]
member val VoiceRecording:String = null with get,set
///<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")>]
member val ItemDescription:String = null with get,set
F# PostServiceTicketRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PostServiceTicketRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<CcInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CcInfo>
<CustomerAcct>0</CustomerAcct>
<CustomerInfo>
<Addr1>String</Addr1>
<Addr2>String</Addr2>
<City>String</City>
<Country>String</Country>
<Email>String</Email>
<Name>String</Name>
<Phone>String</Phone>
<St>String</St>
<WebId>0</WebId>
<Zip>String</Zip>
</CustomerInfo>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<ItemDescription>String</ItemDescription>
<Notes>String</Notes>
<RefNumber>String</RefNumber>
<SerialNumber>String</SerialNumber>
<VoiceRecording>String</VoiceRecording>
</PostServiceTicketRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PostServiceTicketResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<WebRef>String</WebRef>
</PostServiceTicketResponse>