| POST | /api/PostSchedulingGroup |
|---|
"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 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 PostSchedulingPrivateResponse 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 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 PostSchedulingGroupRequest extends BaseRequest {
/** @param {{ClassId?:string,AppointmentStart?:string,StudentName?:string,RefNumber?:string,CustomerAcct?:number,CustomerInfo?:CustomerInfo,FormInputList?:FormInput[],CcInfo?:CcInfo,Notes?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Class ID */
ClassId;
/**
* @type {?string}
* @description The start date of the student. */
AppointmentStart;
/**
* @type {string}
* @description The name of the student */
StudentName;
/**
* @type {string}
* @description Online reference number of this appointment */
RefNumber;
/**
* @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;
}
JavaScript PostSchedulingGroupRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/PostSchedulingGroup HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ClassId":"00000000000000000000000000000000","AppointmentStart":"0001-01-01T00:00:00.0000000","StudentName":"String","RefNumber":"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","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}