AIM Web Services

<back to all web services

StationReservationRequest

StationReservation
Requires active-e Range Reservations Service

The following routes are available for this service:
POST/api/StationReservation
StationReservationRequest Parameters:
NameParameterData TypeRequiredDescription
StationIdqueryintegerYesThe ID of the station being reserved
AcctqueryintegerNoThe Customer Acct assosicated with the reservation. Either this or CustomerInfo is required.
CustomerInfoqueryobjectNo
CcInfoqueryobjectNo
StartquerystringYesThe start date/time of the reservation.
LengthqueryintegerYesThe length (in minutes) of the reservation.
GuestsqueryintegerNoNumber of guests (in addition to the customer) included in this reservation. Defaults to 0.
NotesquerystringNoNotes
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
CustomerInfo Parameters:
NameParameterData TypeRequiredDescription
WebIdqueryintegerYesThe WebId of the customer. Optional.
NamequerystringYesName of the customer.
Addr1querystringNoAddress line 1 of the customer
Addr2querystringNoAddress line 2 of the customer
CityquerystringNoCity of the customer
StquerystringNoState/Province of the customer
ZipquerystringNoZip code of the customer
CountryquerystringNoCountry of the customer
PhonequerystringNoPhone number of the customer
EmailquerystringYesEmail address of the customer. Required.
CcInfo Parameters:
NameParameterData TypeRequiredDescription
TokenStrquerystringYesToken returned from processor
CardTypequerystringYesCard Type (VISA, MCARD, AMEX, DSCVR)
LastFourquerystringYesLast four of the card
ExpirationquerystringNoExpiration Date of the Card. (MM/YY)
ReasonOnFilequerystringNoReason the card is on file.
TokenPkqueryintegerNoID of the existing Token Record in AIM, if applicable
PrimaryquerybooleanNoIs this the customer's primary card? Defaults to false.
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>