AIM Web Services

C2BGetInstrumentInfoRequest

C2BGetInstrumentInfo
Requires active-e Contracts Service.

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

**C2BGetInstrumentInfoRequest** Parameters:
Name	Parameter	Data Type	Required	Description
RsiPk	query	integer	No	ID of the Teacher/Instrument record.
TeacherId	query	integer	No	ID of the Teacher record.
PlanCode	query	string	No	Optional Plan Code Override. If not sent, plancode from the school will be used.
GetDetails	query	boolean	No	If set to false, less details will be sent. Defaults to True.
IncludeOutOfStockItems	query	boolean	No	If set to true, Out of Stock items will be included.
IncludeAccessoryOptions	query	boolean	No	If set to true, each instrument will include a list of accessory options. Defaults to False.
IncludeDeliveryOptions	query	boolean	No	If set to true, each instrument will include a list of delivery options. Defaults to False.
IncludeMaintenanceOptions	query	boolean	No	If set to true, each instrument will include a list of maintenance options. Defaults to False.

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

**C2BGetInstrumentInfoResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Instruments	form	List<C2BInstrumentGeneric>	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

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

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

<C2BGetInstrumentInfoRequest 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>
  <GetDetails>false</GetDetails>
  <IncludeAccessoryOptions>false</IncludeAccessoryOptions>
  <IncludeDeliveryOptions>false</IncludeDeliveryOptions>
  <IncludeMaintenanceOptions>false</IncludeMaintenanceOptions>
  <IncludeOutOfStockItems>false</IncludeOutOfStockItems>
  <PlanCode>String</PlanCode>
  <RsiPk>0</RsiPk>
  <TeacherId>0</TeacherId>
</C2BGetInstrumentInfoRequest>

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

<C2BGetInstrumentInfoResponse 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>
  <Instruments xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:C2BInstrumentGeneric i:nil="true" />
  </Instruments>
</C2BGetInstrumentInfoResponse>

AIM Web Services

C2BGetInstrumentInfoRequest

C2BGetInstrumentInfo Requires active-e Contracts Service.

HTTP + XML

C2BGetInstrumentInfo
Requires active-e Contracts Service.