| POST | /api/StationReservation |
|---|
"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 StationReservationResponse extends BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
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 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 StationReservationRequest extends BaseSecureRequest {
/** @param {{StationId?:number,Acct?:number,CustomerInfo?:CustomerInfo,CcInfo?:CcInfo,Start?:string,Length?:number,Guests?:number,Notes?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the station being reserved */
StationId;
/**
* @type {?number}
* @description The Customer Acct assosicated with the reservation. Either this or CustomerInfo is required. */
Acct;
/** @type {CustomerInfo} */
CustomerInfo;
/** @type {CcInfo} */
CcInfo;
/**
* @type {string}
* @description The start date/time of the reservation. */
Start;
/**
* @type {number}
* @description The length (in minutes) of the reservation. */
Length;
/**
* @type {number}
* @description Number of guests (in addition to the customer) included in this reservation. Defaults to 0. */
Guests;
/**
* @type {string}
* @description Notes */
Notes;
}
JavaScript StationReservationRequest 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/StationReservation HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<StationReservationRequest 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>
<Acct>0</Acct>
<CcInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CcInfo>
<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>
<Guests>0</Guests>
<Length>0</Length>
<Notes>String</Notes>
<Start>0001-01-01T00:00:00</Start>
<StationId>0</StationId>
</StationReservationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StationReservationResponse 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>
</StationReservationResponse>