| POST | /api/PostServiceTicket |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Token;
/** @type {string} */
DeviceId;
/** @type {string} */
AppId;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class PostServiceTicketResponse extends BaseResponse {
/** @param {{WebRef?:string,Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
WebRef;
}
export class CustomerInfo {
/** @param {{WebId?:number,Name?:string,Addr1?:string,Addr2?:string,City?:string,St?:string,Zip?:string,Country?:string,Phone?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The WebId of the customer. Optional. */
WebId;
/**
* @type {string}
* @description Name of the customer. */
Name;
/**
* @type {string}
* @description Address line 1 of the customer */
Addr1;
/**
* @type {string}
* @description Address line 2 of the customer */
Addr2;
/**
* @type {string}
* @description City of the customer */
City;
/**
* @type {string}
* @description State/Province of the customer */
St;
/**
* @type {string}
* @description Zip code of the customer */
Zip;
/**
* @type {string}
* @description Country of the customer */
Country;
/**
* @type {string}
* @description Phone number of the customer */
Phone;
/**
* @type {string}
* @description Email address of the customer. Required. */
Email;
}
export class FormInput {
/** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Field Name of the Input Field */
Key;
/**
* @type {string}
* @description Value of the Input Field. */
Value;
/**
* @type {boolean}
* @description Whether or not the field is encryped with the C2B encryption key. */
Encrypted;
}
export class CcInfo {
/** @param {{TokenStr?:string,CardType?:string,LastFour?:string,Expiration?:string,ReasonOnFile?:string,TokenPk?:number,Primary?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Token returned from processor */
TokenStr;
/**
* @type {string}
* @description Card Type (VISA, MCARD, AMEX, DSCVR) */
CardType;
/**
* @type {string}
* @description Last four of the card */
LastFour;
/**
* @type {string}
* @description Expiration Date of the Card. (MM/YY) */
Expiration;
/**
* @type {string}
* @description Reason the card is on file. */
ReasonOnFile;
/**
* @type {?number}
* @description ID of the existing Token Record in AIM, if applicable */
TokenPk;
/**
* @type {?boolean}
* @description Is this the customer's primary card? Defaults to false. */
Primary;
}
export class PostServiceTicketRequest extends BaseSecureRequest {
/** @param {{RefNumber?:string,SerialNumber?:string,CustomerAcct?:number,CustomerInfo?:CustomerInfo,FormInputList?:FormInput[],CcInfo?:CcInfo,Notes?:string,VoiceRecording?:string,ItemDescription?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Online reference number of this appointment */
RefNumber;
/**
* @type {string}
* @description Serial number of the item to be serviced */
SerialNumber;
/**
* @type {?number}
* @description The AIM customer account # of the customer. Optional. */
CustomerAcct;
/**
* @type {CustomerInfo}
* @description Customer Information */
CustomerInfo;
/**
* @type {FormInput[]}
* @description Additional Customer or Appointment info */
FormInputList;
/**
* @type {CcInfo}
* @description Credit Card info of the customer for this appointment */
CcInfo;
/**
* @type {string}
* @description Notes on this appointment */
Notes;
/** @type {string} */
VoiceRecording;
/**
* @type {string}
* @description Description of the item to be serviced */
ItemDescription;
}
JavaScript 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>