AIM Web Services

<back to all web services

PostSchedulingGroupRequest

PostSchedulingGroup
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST/api/PostSchedulingGroup
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class BaseRequest
            '''<Summary>
            '''This is your AIM API Key provided by Tri-Tech
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="This is your AIM API Key provided by Tri-Tech", IsRequired:=true, Name:="ApiKey", ParameterType:="header")>
            Public Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract(Name:="CCInfo")>
        Public Partial Class CcInfo
            '''<Summary>
            '''Token returned from processor
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Token returned from processor", IsRequired:=true, Name:="TokenStr", ParameterType:="query")>
            Public Overridable Property TokenStr As String

            '''<Summary>
            '''Card Type (VISA, MCARD, AMEX, DSCVR)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired:=true, Name:="CardType", ParameterType:="query")>
            Public Overridable Property CardType As String

            '''<Summary>
            '''Last four of the card
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Last four of the card", IsRequired:=true, Name:="LastFour", ParameterType:="query")>
            Public Overridable Property LastFour As String

            '''<Summary>
            '''Expiration Date of the Card. (MM/YY)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Expiration Date of the Card. (MM/YY)", Name:="Expiration", ParameterType:="query")>
            Public Overridable Property Expiration As String

            '''<Summary>
            '''Reason the card is on file.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Reason the card is on file.", Name:="ReasonOnFile", ParameterType:="query")>
            Public Overridable Property ReasonOnFile As String

            '''<Summary>
            '''ID of the existing Token Record in AIM, if applicable
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="ID of the existing Token Record in AIM, if applicable", Format:="int64", Name:="TokenPk", ParameterType:="query")>
            Public Overridable Property TokenPk As Nullable(Of Long)

            '''<Summary>
            '''Is this the customer's primary card? Defaults to false.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="Is this the customer's primary card? Defaults to false.", Name:="Primary", ParameterType:="query")>
            Public Overridable Property Primary As Nullable(Of Boolean)
        End Class

        <DataContract(Name:="CustomerInfo")>
        Public Partial Class CustomerInfo
            '''<Summary>
            '''The WebId of the customer. Optional.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The WebId of the customer. Optional.", Format:="int32", IsRequired:=true, Name:="WebId", ParameterType:="query")>
            Public Overridable Property WebId As Nullable(Of Integer)

            '''<Summary>
            '''Name of the customer.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Name of the customer.", IsRequired:=true, Name:="Name", ParameterType:="query")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Address line 1 of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Address line 1 of the customer", Name:="Addr1", ParameterType:="query")>
            Public Overridable Property Addr1 As String

            '''<Summary>
            '''Address line 2 of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Address line 2 of the customer", Name:="Addr2", ParameterType:="query")>
            Public Overridable Property Addr2 As String

            '''<Summary>
            '''City of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="City of the customer", Name:="City", ParameterType:="query")>
            Public Overridable Property City As String

            '''<Summary>
            '''State/Province of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="State/Province of the customer", Name:="St", ParameterType:="query")>
            Public Overridable Property St As String

            '''<Summary>
            '''Zip code of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Zip code of the customer", Name:="Zip", ParameterType:="query")>
            Public Overridable Property Zip As String

            '''<Summary>
            '''Country of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Country of the customer", Name:="Country", ParameterType:="query")>
            Public Overridable Property Country As String

            '''<Summary>
            '''Phone number of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Phone number of the customer", Name:="Phone", ParameterType:="query")>
            Public Overridable Property Phone As String

            '''<Summary>
            '''Email address of the customer. Required.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Email address of the customer. Required.", IsRequired:=true, Name:="Email", ParameterType:="query")>
            Public Overridable Property Email As String
        End Class

        <DataContract(Name:="FormInput")>
        Public Partial Class FormInput
            '''<Summary>
            '''Field Name of the Input Field
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Field Name of the Input Field", IsRequired:=true, Name:="Key", ParameterType:="query")>
            Public Overridable Property Key As String

            '''<Summary>
            '''Value of the Input Field.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="query")>
            Public Overridable Property Value As String

            '''<Summary>
            '''Whether or not the field is encryped with the C2B encryption key.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", IsRequired:=true, Name:="Encrypted", ParameterType:="query")>
            Public Overridable Property Encrypted As Boolean
        End Class

        '''<Summary>
        '''PostSchedulingGroupRequires active-e Lesson Scheduling Service
        '''</Summary>
        <DataContract>
        Public Partial Class PostSchedulingGroupRequest
            Inherits BaseRequest
            Public Sub New()
                FormInputList = New List(Of FormInput)
            End Sub

            '''<Summary>
            '''Class ID
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Class ID", IsRequired:=true, Name:="ClassId", ParameterType:="query")>
            Public Overridable Property ClassId As Guid

            '''<Summary>
            '''The start date of the student.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The start date of the student.", Format:="date-time", Name:="StartDate", ParameterType:="query")>
            Public Overridable Property AppointmentStart As Nullable(Of Date)

            '''<Summary>
            '''The name of the student
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The name of the student", IsRequired:=true, Name:="StudentName", ParameterType:="query")>
            Public Overridable Property StudentName As String

            '''<Summary>
            '''Online reference number of this appointment
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Online reference number of this appointment", Name:="RefNumber", ParameterType:="query")>
            Public Overridable Property RefNumber As String

            '''<Summary>
            '''The AIM customer account # of the customer. Optional.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The AIM customer account # of the customer. Optional.", Format:="int32", Name:="CustomerAcct", ParameterType:="query")>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)

            '''<Summary>
            '''Customer Information
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="object", Description:="Customer Information", Name:="CustomerInfo", ParameterType:="query")>
            Public Overridable Property CustomerInfo As CustomerInfo

            '''<Summary>
            '''Additional Customer or Appointment info
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="Additional Customer or Appointment info", Name:="FormInputList", ParameterType:="query")>
            Public Overridable Property FormInputList As List(Of FormInput)

            '''<Summary>
            '''Credit Card info of the customer for this appointment
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="object", Description:="Credit Card info of the customer for this appointment", Name:="CcInfo", ParameterType:="query")>
            Public Overridable Property CcInfo As CcInfo

            '''<Summary>
            '''Notes on this appointment
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Notes on this appointment", Name:="Notes", ParameterType:="query")>
            Public Overridable Property Notes As String
        End Class

        <DataContract>
        Public Partial Class PostSchedulingPrivateResponse
            Inherits BaseResponse
        End Class
    End Namespace
End Namespace

VB.NET PostSchedulingGroupRequest DTOs

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/PostSchedulingGroup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostSchedulingGroupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppointmentStart>0001-01-01T00:00:00</AppointmentStart>
  <CcInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CcInfo>
  <ClassId>00000000-0000-0000-0000-000000000000</ClassId>
  <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>
  <Notes>String</Notes>
  <RefNumber>String</RefNumber>
  <StudentName>String</StudentName>
</PostSchedulingGroupRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostSchedulingPrivateResponse 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>
</PostSchedulingPrivateResponse>