AIM Web Services

C2BGetInstrumentDetailRequest

C2BGetInstrumentDetail
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET	/api/C2BGetInstrumentDetail

**C2BGetInstrumentDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
RsiPk	query	integer	No	ID of the Teacher/Instrument record. Either this or TeacherId + InstrumentId must be sent.
TeacherId	query	integer	No	ID of the Teacher record. Either this+InstrumentID or RsiPk must be sent.
InstrumentId	query	integer	No	ID of the Instrument record. Either this+TeacherID or RsiPk must be sent.
RateId	query	integer	Yes	ID of the Rate to be used. This is required.
IncludeMobileLayout	query	string	No	If 'Y', then Mobile Layout will be returned.
DeliveryId	query	integer	Yes	ID of the Delivery option to be used.
LocationId	query	integer	Yes	ID of the Location. Used for Location required Delivery options.

**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

**C2BGetInstrumentDetailResponse** Parameters:
Name	Parameter	Data Type	Required	Description
InstrumentDetails	form	C2BInstrumentDetailGeneric	No
MobileLayout	form	MobileLayout	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

**C2BInstrumentDetailGeneric** Parameters:
Name	Parameter	Data Type	Required
PlanCode	form	C2BPlanCodeGeneric	No
Teacher	form	C2BTeacherGeneric	No
School	form	C2BSchoolGeneric	No
DeliveryDate	form	string	No
SalesPerson	form	string	No
District	form	C2BDistrictGeneric	No
Instrument	form	C2BInstrumentGeneric	No
Grade	form	C2BGradeGeneric	No
AccessoryList	form	List<C2BAccessoryGeneric>	No
DeliveryList	form	List<C2BAccessoryGeneric>	No
MaintenanceList	form	List<C2BAccessoryGeneric>	No

**C2BPlanCodeGeneric** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Months	form	int	No
Topic	form	string	No
Url	form	string	No
FinalTopic	form	string	No

**C2BTeacherGeneric** Parameters:
Name	Parameter	Data Type	Required
TeacherName	form	string	No
SchoolName	form	string	No
DistrictName	form	string	No
Topic	form	string	No
Id	form	long	No
DeliveryInfo	form	C2BDeliveryInfo	No
AIMSchoolId	form	long?	No

**C2BDeliveryInfo** Parameters:
Name	Parameter	Data Type	Required
FirstDelivery	form	DateTime	No
DeliveryTime	form	DateTime	No
DeliveryThreshold	form	int	No
SundayDelivery	form	bool	No
MondayDelivery	form	bool	No
TuesdayDelivery	form	bool	No
WednesdayDelivery	form	bool	No
ThursdayDelivery	form	bool	No
FridayDelivery	form	bool	No
SaturdayDelivery	form	bool	No

**C2BSchoolGeneric** Parameters:
Name	Parameter	Data Type	Required
SchoolName	form	string	No
DistrictName	form	string	No
TeacherCount	form	int	No
Topic	form	string	No
Id	form	long	No
DeliveryInfo	form	C2BDeliveryInfo	No
AIMSchoolId	form	long?	No

**C2BDistrictGeneric** Parameters:
Name	Parameter	Data Type	Required
DistrictName	form	string	No
SchoolCount	form	int	No
TeacherCount	form	int	No
Topic	form	string	No
Id	form	long	No
State	form	string	No

**C2BInstrumentGeneric** Parameters:
Name	Parameter	Data Type	Required
InstrumentName	form	string	No
Sku	form	string	No
Topic	form	string	No
Image	form	string	No
Level	form	int	No
RentPrice	form	decimal?	No
CashPrice	form	decimal?	No
Token	form	string	No
InstrumentId	form	long	No
InstrumentTeacherId	form	long	No
GradeList	form	List<C2BGradeGeneric>	No
HasGrades	form	bool	No
DisplayOrder	form	int	No
AccessoryList	form	List<C2BAccessoryGeneric>	No
DeliveryList	form	List<C2BAccessoryGeneric>	No
MaintenanceList	form	List<C2BAccessoryGeneric>	No

**C2BGradeGeneric** Parameters:
Name	Parameter	Data Type	Required
Level	form	int	No
Grade	form	string	No
DownPay	form	decimal	No
DownMaint	form	decimal	No
MoPay	form	decimal	No
MoMaint	form	decimal	No
Id	form	long	No
OutOfStock	form	bool	No
RentPrice	form	decimal	No
CashPrice	form	decimal	No
DownPayTax	form	decimal?	No
DownMaintTax	form	decimal?	No
MoPayTax	form	decimal?	No
MoMaintTax	form	decimal?	No
RentPricePlusTax	form	decimal	No
RentPricePlusTaxLessDownpay	form	decimal	No
Months	form	int	No

**C2BAccessoryGeneric** Parameters:
Name	Parameter	Data Type	Required
AccessoryDesc	form	string	No
Price	form	decimal	No
Required	form	bool	No
Default	form	bool	No
RequiresLocation	form	bool	No
Type	form	string	No
Topic	form	string	No
Id	form	long	No
DisplayOrder	form	int	No
Sku	form	string	No
TaxAmount	form	decimal?	No
CatNum	form	int?	No

**MobileLayout** Parameters:
Name	Parameter	Data Type	Required
title	form	string	No
returnurl	form	string	No
sections	form	Section[]	No

**Section** Parameters:
Name	Parameter	Data Type	Required
header	form	string	No
id	form	string	No
margin	form	string	No
elements	form	Element[]	No

**Element** Parameters:
Name	Parameter	Data Type	Required
type	form	string	No
label	form	string	No
id	form	string	No
fontsize	form	string	No
margin	form	string	No
backgroundcolor	form	string	No
textcolor	form	string	No
height	form	string	No
width	form	string	No
value	form	string	No
addvalue	form	bool	No
values	form	string[]	No
textalign	form	string	No
required	form	bool?	No
placeholder	form	string	No
fontbold	form	bool?	No
selected	form	bool?	No
disabled	form	bool?	No
totalamount	form	bool?	No
elements	form	IEnumerable<Element>	No
map	form	IEnumerable<LicenseMap>	No

**LicenseMap** Parameters:
Name	Parameter	Data Type	Required	Description
name	form	string	No
value	form	string	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.

POST /api/C2BGetInstrumentDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<C2BGetInstrumentDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <DeliveryId>0</DeliveryId>
  <IncludeMobileLayout>String</IncludeMobileLayout>
  <InstrumentId>0</InstrumentId>
  <LocationId>0</LocationId>
  <RateId>0</RateId>
  <RsiPk>0</RsiPk>
  <TeacherId>0</TeacherId>
</C2BGetInstrumentDetailRequest>

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

<C2BGetInstrumentDetailResponse 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>
  <InstrumentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM" i:nil="true" />
  <MobileLayout xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.ExternalAPIs.MobileRentals">
    <d2p1:returnurl>String</d2p1:returnurl>
    <d2p1:sections>
      <d2p1:MobileLayout.Section>
        <d2p1:elements>
          <d2p1:MobileLayout.Element>
            <d2p1:addvalue>false</d2p1:addvalue>
            <d2p1:backgroundcolor>String</d2p1:backgroundcolor>
            <d2p1:disabled>false</d2p1:disabled>
            <d2p1:elements i:nil="true" />
            <d2p1:fontbold>false</d2p1:fontbold>
            <d2p1:fontsize>String</d2p1:fontsize>
            <d2p1:height>String</d2p1:height>
            <d2p1:id>String</d2p1:id>
            <d2p1:label>String</d2p1:label>
            <d2p1:map i:nil="true" />
            <d2p1:margin>String</d2p1:margin>
            <d2p1:placeholder>String</d2p1:placeholder>
            <d2p1:required>false</d2p1:required>
            <d2p1:selected>false</d2p1:selected>
            <d2p1:textalign>String</d2p1:textalign>
            <d2p1:textcolor>String</d2p1:textcolor>
            <d2p1:totalamount>false</d2p1:totalamount>
            <d2p1:type>String</d2p1:type>
            <d2p1:value>String</d2p1:value>
            <d2p1:values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:values>
            <d2p1:width>String</d2p1:width>
          </d2p1:MobileLayout.Element>
        </d2p1:elements>
        <d2p1:header>String</d2p1:header>
        <d2p1:id>String</d2p1:id>
        <d2p1:margin>String</d2p1:margin>
      </d2p1:MobileLayout.Section>
    </d2p1:sections>
    <d2p1:title>String</d2p1:title>
  </MobileLayout>
</C2BGetInstrumentDetailResponse>

AIM Web Services

C2BGetInstrumentDetailRequest

C2BGetInstrumentDetail Requires active-e Contracts Service.

HTTP + XML

C2BGetInstrumentDetail
Requires active-e Contracts Service.