AIM Web Services

<back to all web services

PostSchedulingPrivateRequest

PostSchedulingPrivate
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST/api/PostSchedulingPrivate

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PostSchedulingPrivateResponse extends BaseResponse
{

    public constructor(init?: Partial<PostSchedulingPrivateResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CustomerInfo")
export class CustomerInfo
{
    /** @description The WebId of the customer. Optional. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
    public WebId: number;

    /** @description Name of the customer. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
    public Name: string;

    /** @description Address line 1 of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
    public Addr1: string;

    /** @description Address line 2 of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
    public Addr2: string;

    /** @description City of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
    public City: string;

    /** @description State/Province of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
    public St: string;

    /** @description Zip code of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
    public Zip: string;

    /** @description Country of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
    public Country: string;

    /** @description Phone number of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
    public Phone: string;

    /** @description Email address of the customer. Required. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
    public Email: string;

    public constructor(init?: Partial<CustomerInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="FormInput")
export class FormInput
{
    /** @description Field Name of the Input Field */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    public Key: string;

    /** @description Value of the Input Field. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    public Value: string;

    /** @description Whether or not the field is encryped with the C2B encryption key. */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    public Encrypted: boolean;

    public constructor(init?: Partial<FormInput>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CCInfo")
export class CcInfo
{
    /** @description Token returned from processor */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    public TokenStr: string;

    /** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    public CardType: string;

    /** @description Last four of the card */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    public LastFour: string;

    /** @description Expiration Date of the Card. (MM/YY) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    public Expiration: string;

    /** @description Reason the card is on file. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    public ReasonOnFile: string;

    /** @description ID of the existing Token Record in AIM, if applicable */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    public TokenPk?: number;

    /** @description Is this the customer's primary card? Defaults to false. */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    public Primary?: boolean;

    public constructor(init?: Partial<CcInfo>) { (Object as any).assign(this, init); }
}

/** @description PostSchedulingPrivateRequires active-e Lesson Scheduling Service */
// @DataContract
export class PostSchedulingPrivateRequest extends BaseRequest
{
    /** @description The type ID of the private appointment */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The type ID of the private appointment", Format="int64", IsRequired=true, Name="TypeId", ParameterType="query")
    public TypeId: number;

    /** @description The Instructor ID of the appointment */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The Instructor ID of the appointment", Format="int32", IsRequired=true, Name="InstructorId", ParameterType="query")
    public InstructorId: number;

    /** @description IThe location ID of the appointment */
    // @DataMember
    // @ApiMember(DataType="integer", Description="IThe location ID of the appointment", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    public LocationId: number;

    /** @description The start time of the appointment. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The start time of the appointment.", Format="date-time", IsRequired=true, Name="AppointmentStart", ParameterType="query")
    public AppointmentStart: string;

    /** @description The name of the student */
    // @DataMember
    // @ApiMember(DataType="string", Description="The name of the student", IsRequired=true, Name="StudentName", ParameterType="query")
    public StudentName: string;

    /** @description Online reference number of this appointment */
    // @DataMember
    // @ApiMember(DataType="string", Description="Online reference number of this appointment", Name="RefNumber", ParameterType="query")
    public RefNumber: string;

    /** @description The AIM customer account # of the customer. Optional. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The AIM customer account # of the customer. Optional.", Format="int32", Name="CustomerAcct", ParameterType="query")
    public CustomerAcct?: number;

    /** @description Customer Information */
    // @DataMember
    // @ApiMember(DataType="object", Description="Customer Information", Name="CustomerInfo", ParameterType="query")
    public CustomerInfo: CustomerInfo;

    /** @description Additional Customer or Appointment info */
    // @DataMember
    // @ApiMember(DataType="array", Description="Additional Customer or Appointment info", Name="FormInputList", ParameterType="query")
    public FormInputList: FormInput[];

    /** @description Credit Card info of the customer for this appointment */
    // @DataMember
    // @ApiMember(DataType="object", Description="Credit Card info of the customer for this appointment", Name="CcInfo", ParameterType="query")
    public CcInfo: CcInfo;

    /** @description Notes on this appointment */
    // @DataMember
    // @ApiMember(DataType="string", Description="Notes on this appointment", Name="Notes", ParameterType="query")
    public Notes: string;

    public constructor(init?: Partial<PostSchedulingPrivateRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript PostSchedulingPrivateRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/PostSchedulingPrivate HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TypeId":0,"InstructorId":0,"LocationId":0,"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: text/jsonl
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}