AIM Web Services

<back to all web services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BGetUnfinishedContracts

// @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 BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (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 LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    // @DataMember
    public Region: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

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

// @DataContract
export class C2BAccessory
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Description: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public Type: string;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Category?: number;

    // @DataMember
    public Delivered: boolean;

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

// @DataContract
export class UnfinishedContract
{
    // @DataMember
    public CustomerName: string;

    // @DataMember
    public CustomerAcct: number;

    // @DataMember
    public StudentName: string;

    // @DataMember
    public Ref: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Location: LocationInfo;

    // @DataMember
    public District: string;

    // @DataMember
    public School: string;

    // @DataMember
    public Teacher: string;

    // @DataMember
    public Instrument: string;

    // @DataMember
    public Status: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public LockedBy: string;

    // @DataMember
    public InstrumentGrade: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Salesperson: string;

    // @DataMember
    public WebNotes: string;

    // @DataMember
    public Email: string;

    // @DataMember
    public Phone: string;

    // @DataMember
    public DeliveryDate?: string;

    // @DataMember
    public FirstDue?: string;

    // @DataMember
    public Accessories: C2BAccessory[];

    // @DataMember
    public DownPay: number;

    // @DataMember
    public MonthlyPay: number;

    // @DataMember
    public DownMaint: number;

    // @DataMember
    public MonthlyMaint: number;

    // @DataMember
    public DownLease: number;

    // @DataMember
    public MonthlyLease: number;

    // @DataMember
    public DownTotal: number;

    // @DataMember
    public Address: string;

    // @DataMember
    public Address2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Country: string;

    // @DataMember
    public InvoiceCreated: boolean;

    // @DataMember
    public ContractCreated: boolean;

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

// @DataContract
export class C2BGetUnfinishedContractsResponse extends BaseResponse
{
    // @DataMember
    public UnfinishedContracts: UnfinishedContract[];

    // @DataMember
    public Topic: string;

    // @DataMember
    public BaseUrl: string;

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

/** @description C2BGetUnfinishedContractsRequires active-e Contracts Service. */
// @DataContract
export class C2BGetUnfinishedContractsRequest extends BaseSecureRequest
{
    // @DataMember
    public Type: string;

    // @DataMember
    public StartOffset?: number;

    // @DataMember
    public RecordCount?: number;

    // @DataMember
    public SearchStr: string;

    // @DataMember
    public IncludeContractsEnteredByOtherUsers: boolean;

    // @DataMember
    public DistrictId?: number;

    // @DataMember
    public SchoolId?: number;

    // @DataMember
    public TeacherId?: number;

    // @DataMember
    public DeliveryDesc: string;

    // @DataMember
    public Status: string;

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

TypeScript C2BGetUnfinishedContractsRequest 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.

GET /api/C2BGetUnfinishedContracts HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<C2BGetUnfinishedContractsResponse 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>
  <BaseUrl>String</BaseUrl>
  <Topic>String</Topic>
  <UnfinishedContracts>
    <C2BGetUnfinishedContractsResponse.UnfinishedContract>
      <Accessories>
        <C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
          <Category>0</Category>
          <Delivered>false</Delivered>
          <Description>String</Description>
          <Id>0</Id>
          <Price>0</Price>
          <Sku>String</Sku>
          <Type>String</Type>
        </C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
      </Accessories>
      <Address>String</Address>
      <Address2>String</Address2>
      <City>String</City>
      <ContractCreated>false</ContractCreated>
      <Country>String</Country>
      <CustomerAcct>0</CustomerAcct>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <District>String</District>
      <DownLease>0</DownLease>
      <DownMaint>0</DownMaint>
      <DownPay>0</DownPay>
      <DownTotal>0</DownTotal>
      <Email>String</Email>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <Instrument>String</Instrument>
      <InstrumentGrade>String</InstrumentGrade>
      <InvoiceCreated>false</InvoiceCreated>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <LockedBy>String</LockedBy>
      <MonthlyLease>0</MonthlyLease>
      <MonthlyMaint>0</MonthlyMaint>
      <MonthlyPay>0</MonthlyPay>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Ref>String</Ref>
      <Salesperson>String</Salesperson>
      <School>String</School>
      <Serial>String</Serial>
      <State>String</State>
      <Status>String</Status>
      <StudentName>String</StudentName>
      <Teacher>String</Teacher>
      <WebNotes>String</WebNotes>
      <Zip>String</Zip>
    </C2BGetUnfinishedContractsResponse.UnfinishedContract>
  </UnfinishedContracts>
</C2BGetUnfinishedContractsResponse>