AIM Web Services

<back to all web services

ServiceTicketFullDetailsRequest

ServiceTicketFullDetails
Requires active-e Service Tickets Service

The following routes are available for this service:
GET/api/ServiceTicketFullDetails

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

export class PartInfo
{
    // @DataMember
    public Description: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public Discount: number;

    // @DataMember
    public Total: number;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public CategoryDescription: string;

    // @DataMember
    public Sku: string;

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

export class ServiceInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Parts: PartInfo[];

    // @DataMember
    public Description: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Rate: number;

    // @DataMember
    public Discount: number;

    // @DataMember
    public Total: number;

    // @DataMember
    public Time: number;

    // @DataMember
    public Completed: boolean;

    // @DataMember
    public CompletedDate: string;

    // @DataMember
    public Technician: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public CategoryDescription: string;

    // @DataMember
    public TimerActive: boolean;

    // @DataMember
    public TimerStartTime?: string;

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

export class DepositInfo
{
    // @DataMember
    public OriginalAmount: number;

    // @DataMember
    public Amount: number;

    // @DataMember
    public RefNumber: string;

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

// @DataContract
export class TicketInfo
{
    // @DataMember
    public Terms: number;

    // @DataMember
    public PoNumber: string;

    // @DataMember
    public ReturnAuthorizationNumber: string;

    // @DataMember
    public Status: string;

    // @DataMember
    public ApprovedAmount: number;

    // @DataMember
    public TotalDue: number;

    // @DataMember
    public Subtotal: number;

    // @DataMember
    public Tax1: number;

    // @DataMember
    public Tax2: number;

    // @DataMember
    public ApprovedDate: string;

    // @DataMember
    public BilledDate: string;

    // @DataMember
    public Contact: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public Services: ServiceInfo[];

    // @DataMember
    public CategoryDescription: string;

    // @DataMember
    public SubCategory: number;

    // @DataMember
    public SubCategoryDescription: string;

    // @DataMember
    public Item: string;

    // @DataMember
    public ItemDescription: string;

    // @DataMember
    public Manufacturer: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Timestamp: string;

    // @DataMember
    public SoldToCustomerAcct: number;

    // @DataMember
    public BillToCustomerAcct: number;

    // @DataMember
    public Model: string;

    // @DataMember
    public StLoc: string;

    // @DataMember
    public TaxLoc: string;

    // @DataMember
    public RefNumber: string;

    // @DataMember
    public MasterNumber: string;

    // @DataMember
    public Invoiced: boolean;

    // @DataMember
    public Deposits: DepositInfo[];

    // @DataMember
    public SoldToCustomerName: string;

    // @DataMember
    public BillToCustomerName: string;

    // @DataMember
    public ShipToName: string;

    // @DataMember
    public ShipToId?: number;

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

// @DataContract
export class ServiceTicketFullDetailsResponse extends BaseResponse
{
    // @DataMember
    public Tickets: TicketInfo[];

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

/** @description ServiceTicketFullDetailsRequires active-e Service Tickets Service */
// @DataContract
export class ServiceTicketFullDetailsRequest extends BaseSecureRequest
{
    // @DataMember
    public Acct?: number;

    // @DataMember
    public RefNumber: string;

    // @DataMember
    public ChangedDate?: string;

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

TypeScript ServiceTicketFullDetailsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ServiceTicketFullDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Tickets":[{"Terms":0,"PoNumber":"String","ReturnAuthorizationNumber":"String","Status":"String","ApprovedAmount":0,"TotalDue":0,"Subtotal":0,"Tax1":0,"Tax2":0,"Contact":"String","Category":0,"Services":[{"Id":0,"Parts":[{"Description":"String","Quantity":0,"Price":0,"Discount":0,"Total":0,"Notes":"String","Category":0,"CategoryDescription":"String","Sku":"String"}],"Description":"String","Quantity":0,"Rate":0,"Discount":0,"Total":0,"Time":0,"Completed":false,"Technician":"String","Notes":"String","Category":0,"CategoryDescription":"String","TimerActive":false,"TimerStartTime":"0001-01-01T00:00:00.0000000"}],"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Item":"String","ItemDescription":"String","Manufacturer":"String","Notes":"String","SoldToCustomerAcct":0,"BillToCustomerAcct":0,"Model":"String","StLoc":"String","TaxLoc":"String","RefNumber":"String","MasterNumber":"String","Invoiced":false,"Deposits":[{"OriginalAmount":0,"Amount":0,"RefNumber":"String"}],"SoldToCustomerName":"String","BillToCustomerName":"String","ShipToName":"String","ShipToId":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}