AIM Web Services

<back to all web services

CustomerDependantRequest

CustomerDependant
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/CustomerDependant

// @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;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (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 CustomerDependantResponse extends BaseResponse
{

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

// @DataContract
export class AttributeData
{
    // @DataMember
    public Name: string;

    // @DataMember
    public Value: string;

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

/** @description CustomerDependantRequires active-e Customer Service. */
// @DataContract
export class CustomerDependantRequest extends BaseSecureRequest
{
    /** @description AIM Customer Account Number */
    // @DataMember
    // @ApiMember(DataType="integer", Description="AIM Customer Account Number", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
    public Acct: number;

    /** @description Name of the Dependant */
    // @DataMember
    // @ApiMember(DataType="string", Description="Name of the Dependant", IsRequired=true, Name="Name", ParameterType="query")
    public Name: string;

    // @DataMember
    public OnlineId: string;

    // @DataMember
    public SchoolDistrict: string;

    // @DataMember
    public School: string;

    // @DataMember
    public AttributeInfo: AttributeData[];

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

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

{"Acct":0,"Name":"String","OnlineId":"String","SchoolDistrict":"String","School":"String","AttributeInfo":[{"Name":"String","Value":"String"}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

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