Starlite API

<back to all web services

LockboxDocument

// @DataContract
export class ServiceRequestBase implements IHasVersion
{

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

// @DataContract
export class ServiceResponseBase
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    // @DataMember
    // @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    public IsSuccessful?: boolean;

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public StatusCode?: number;

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public StatusMessage?: string;

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public ServiceDebugFields?: { [index: string]: string; };

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

export class LockboxDocument extends ServiceRequestBase
{
    /**
    * The management company that the member's association belongs to
    */
    // @ApiMember(Description="The management company that the member's association belongs to", IsRequired=true)
    public ManagementCompanyId?: string;

    /**
    * The association company that the member belongs to
    */
    // @ApiMember(Description="The association company that the member belongs to", IsRequired=true)
    public AssociationId?: string;

    /**
    * The member ID for whom to retrieve the lockbox document for
    */
    // @ApiMember(Description="The member ID for whom to retrieve the lockbox document for", IsRequired=true)
    public MemberId?: string;

    /**
    * The lockbox document ID identifying which document to pull
    */
    // @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
    public DocumentId: number;

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

TypeScript LockboxDocument DTOs

POST /Members/LockboxDocument HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ManagementCompanyId: String,
	AssociationId: String,
	MemberId: String,
	DocumentId: 0
}

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

{
	IsSuccessful: False,
	StatusCode: 0,
	StatusMessage: String,
	ServiceDebugFields: 
	{
		ApiServiceHost: AZW-AABWPW03,
		ApiServiceHostVersion: 2016.1.18.3
	}
}