AIM Web Services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

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

**C2BGetUnfinishedContractsRequest** Parameters:
Name	Parameter	Data Type	Required
Type	query	string	No
StartOffset	query	int?	No
RecordCount	query	int?	No
SearchStr	query	string	No
IncludeContractsEnteredByOtherUsers	query	bool	No
DistrictId	query	long?	No
SchoolId	query	long?	No
TeacherId	query	long?	No
DeliveryDesc	query	string	No
Status	query	string	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	Header	string	No	The Login Token return by the Security API. Required for secured calls.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	Header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	Header	string	Yes	The OAuthToken token return by AeServices30
DeviceId	Header	string	No	The Device ID of the Mobile Device. Not used for non-mobile devices.
AppId	Header	string	Yes	An identifier for your integration

**C2BGetUnfinishedContractsResponse** Parameters:
Name	Parameter	Data Type	Required
UnfinishedContracts	form	List<UnfinishedContract>	No
Topic	form	string	No
BaseUrl	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**UnfinishedContract** Parameters:
Name	Parameter	Data Type	Required
CustomerName	form	string	No
CustomerAcct	form	int	No
StudentName	form	string	No
Ref	form	string	No
DateTime	form	DateTime	No
Location	form	LocationInfo	No
District	form	string	No
School	form	string	No
Teacher	form	string	No
Instrument	form	string	No
Status	form	string	No
Notes	form	string	No
LockedBy	form	string	No
InstrumentGrade	form	string	No
Serial	form	string	No
Salesperson	form	string	No
WebNotes	form	string	No
Email	form	string	No
Phone	form	string	No
DeliveryDate	form	DateTime?	No
FirstDue	form	DateTime?	No
Accessories	form	List<C2BAccessory>	No
DownPay	form	decimal	No
MonthlyPay	form	decimal	No
DownMaint	form	decimal	No
MonthlyMaint	form	decimal	No
DownLease	form	decimal	No
MonthlyLease	form	decimal	No
DownTotal	form	decimal	No
Address	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Country	form	string	No
InvoiceCreated	form	bool	No
ContractCreated	form	bool	No

**LocationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No
Region	form	string	No
Latitude	form	decimal	No
Longitude	form	decimal	No
InStorePickup	form	string	No
Active	form	bool	No
CashSaleAcct	form	int?	No

**C2BAccessory** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Description	form	string	No
Price	form	decimal	No
Type	form	string	No
Sku	form	string	No
Category	form	int?	No
Delivered	form	bool	No

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>

AIM Web Services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts Requires active-e Contracts Service.

HTTP + XML

C2BGetUnfinishedContracts
Requires active-e Contracts Service.