AIM Web Services

<back to all web services

C2BGetPlanInfoRequest

C2BGetPlanInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetPlanInfo
C2BGetPlanInfoRequest Parameters:
NameParameterData TypeRequiredDescription
PlanCodequerystringNoIf sent, only info on the plan code sent will be returned. Otherwise info on all plan codes will be returned.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
C2BGetPlanInfoResponse Parameters:
NameParameterData TypeRequiredDescription
PlansformList<C2BPlanGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
C2BPlanGeneric Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CodeformstringNo
NameformstringNo
MonthsformintNo
TopicformstringNo
FinalTopicformstringNo
UrlformstringNo

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

<C2BGetPlanInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <PlanCode>String</PlanCode>
</C2BGetPlanInfoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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