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
// @ts-nocheck

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress?: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status?: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BPlanGeneric
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Code?: string;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Months: number;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public FinalTopic?: string;

    // @DataMember
    public Url?: string;

    public constructor(init?: Partial<C2BPlanGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BGetPlanInfoResponse extends BaseResponse
{
    // @DataMember
    public Plans?: C2BPlanGeneric[];

    public constructor(init?: Partial<C2BGetPlanInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description C2BGetPlanInfoRequires active-e Contracts Service. */
// @DataContract
export class C2BGetPlanInfoRequest extends BaseRequest
{
    /** @description If sent, only info on the plan code sent will be returned. Otherwise info on all plan codes will be returned. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, only info on the plan code sent will be returned. Otherwise info on all plan codes will be returned.", Name="PlanCode", ParameterType="query")
    public PlanCode?: string;

    public constructor(init?: Partial<C2BGetPlanInfoRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript C2BGetPlanInfoRequest DTOs

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

{"PlanCode":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

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