AIM Web Services

<back to all web services

C2BGetInstrumentInfoRequest

C2BGetInstrumentInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetInstrumentInfo
C2BGetInstrumentInfoRequest Parameters:
NameParameterData TypeRequiredDescription
RsiPkqueryintegerNoID of the Teacher/Instrument record.
TeacherIdqueryintegerNoID of the Teacher record.
PlanCodequerystringNoOptional Plan Code Override. If not sent, plancode from the school will be used.
GetDetailsquerybooleanNoIf set to false, less details will be sent. Defaults to True.
IncludeOutOfStockItemsquerybooleanNoIf set to true, Out of Stock items will be included.
IncludeAccessoryOptionsquerybooleanNoIf set to true, each instrument will include a list of accessory options. Defaults to False.
IncludeDeliveryOptionsquerybooleanNoIf set to true, each instrument will include a list of delivery options. Defaults to False.
IncludeMaintenanceOptionsquerybooleanNoIf set to true, each instrument will include a list of maintenance options. Defaults to False.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
C2BGetInstrumentInfoResponse Parameters:
NameParameterData TypeRequiredDescription
InstrumentsformList<C2BInstrumentGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
C2BInstrumentGeneric Parameters:
NameParameterData TypeRequiredDescription
InstrumentNameformstringNo
SkuformstringNo
TopicformstringNo
ImageformstringNo
LevelformintNo
RentPriceformdecimal?No
CashPriceformdecimal?No
TokenformstringNo
InstrumentIdformlongNo
InstrumentTeacherIdformlongNo
GradeListformList<C2BGradeGeneric>No
HasGradesformboolNo
DisplayOrderformintNo
AccessoryListformList<C2BAccessoryGeneric>No
DeliveryListformList<C2BAccessoryGeneric>No
MaintenanceListformList<C2BAccessoryGeneric>No
C2BGradeGeneric Parameters:
NameParameterData TypeRequiredDescription
LevelformintNo
GradeformstringNo
DownPayformdecimalNo
DownMaintformdecimalNo
MoPayformdecimalNo
MoMaintformdecimalNo
IdformlongNo
OutOfStockformboolNo
RentPriceformdecimalNo
CashPriceformdecimalNo
DownPayTaxformdecimal?No
DownMaintTaxformdecimal?No
MoPayTaxformdecimal?No
MoMaintTaxformdecimal?No
RentPricePlusTaxformdecimalNo
RentPricePlusTaxLessDownpayformdecimalNo
MonthsformintNo
C2BAccessoryGeneric Parameters:
NameParameterData TypeRequiredDescription
AccessoryDescformstringNo
PriceformdecimalNo
RequiredformboolNo
DefaultformboolNo
RequiresLocationformboolNo
TypeformstringNo
TopicformstringNo
IdformlongNo
DisplayOrderformintNo
SkuformstringNo
TaxAmountformdecimal?No
CatNumformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RsiPk":0,"TeacherId":0,"PlanCode":"String","GetDetails":false,"IncludeOutOfStockItems":false,"IncludeAccessoryOptions":false,"IncludeDeliveryOptions":false,"IncludeMaintenanceOptions":false,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Instruments":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}