AIM Web Services

<back to all web services

ServiceTicketFullDetailsRequest

ServiceTicketFullDetails
Requires active-e Service Tickets Service

"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /**
     * @type {string}
     * @description The OAuthToken token return by AeServices30 */
    OAuthToken;
    /**
     * @type {string}
     * @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    DeviceId;
    /**
     * @type {string}
     * @description An identifier for your integration */
    AppId;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The Login Token return by the Security API. Required for secured calls. */
    Token;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class PartInfo {
    /** @param {{Description?:string,Quantity?:number,Price?:number,Discount?:number,Total?:number,Notes?:string,Category?:number,CategoryDescription?:string,Sku?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {number} */
    Quantity;
    /** @type {number} */
    Price;
    /** @type {number} */
    Discount;
    /** @type {number} */
    Total;
    /** @type {string} */
    Notes;
    /** @type {number} */
    Category;
    /** @type {string} */
    CategoryDescription;
    /** @type {string} */
    Sku;
}
export class ServiceInfo {
    /** @param {{Id?:number,Parts?:PartInfo[],Description?:string,Quantity?:number,Rate?:number,Discount?:number,Total?:number,Time?:number,Completed?:boolean,CompletedDate?:string,Technician?:string,Notes?:string,Category?:number,CategoryDescription?:string,TimerActive?:boolean,TimerStartTime?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {PartInfo[]} */
    Parts;
    /** @type {string} */
    Description;
    /** @type {number} */
    Quantity;
    /** @type {number} */
    Rate;
    /** @type {number} */
    Discount;
    /** @type {number} */
    Total;
    /** @type {number} */
    Time;
    /** @type {boolean} */
    Completed;
    /** @type {string} */
    CompletedDate;
    /** @type {string} */
    Technician;
    /** @type {string} */
    Notes;
    /** @type {number} */
    Category;
    /** @type {string} */
    CategoryDescription;
    /** @type {boolean} */
    TimerActive;
    /** @type {?string} */
    TimerStartTime;
}
export class DepositInfo {
    /** @param {{OriginalAmount?:number,Amount?:number,RefNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    OriginalAmount;
    /** @type {number} */
    Amount;
    /** @type {string} */
    RefNumber;
}
export class TicketInfo {
    /** @param {{Terms?:number,PoNumber?:string,ReturnAuthorizationNumber?:string,Status?:string,ApprovedAmount?:number,TotalDue?:number,Subtotal?:number,Tax1?:number,Tax2?:number,ApprovedDate?:string,BilledDate?:string,Contact?:string,Category?:number,Services?:ServiceInfo[],CategoryDescription?:string,SubCategory?:number,SubCategoryDescription?:string,Item?:string,ItemDescription?:string,Manufacturer?:string,Notes?:string,Timestamp?:string,SoldToCustomerAcct?:number,BillToCustomerAcct?:number,Model?:string,StLoc?:string,TaxLoc?:string,RefNumber?:string,MasterNumber?:string,Invoiced?:boolean,Deposits?:DepositInfo[],SoldToCustomerName?:string,BillToCustomerName?:string,ShipToName?:string,ShipToId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Terms;
    /** @type {string} */
    PoNumber;
    /** @type {string} */
    ReturnAuthorizationNumber;
    /** @type {string} */
    Status;
    /** @type {number} */
    ApprovedAmount;
    /** @type {number} */
    TotalDue;
    /** @type {number} */
    Subtotal;
    /** @type {number} */
    Tax1;
    /** @type {number} */
    Tax2;
    /** @type {string} */
    ApprovedDate;
    /** @type {string} */
    BilledDate;
    /** @type {string} */
    Contact;
    /** @type {number} */
    Category;
    /** @type {ServiceInfo[]} */
    Services;
    /** @type {string} */
    CategoryDescription;
    /** @type {number} */
    SubCategory;
    /** @type {string} */
    SubCategoryDescription;
    /** @type {string} */
    Item;
    /** @type {string} */
    ItemDescription;
    /** @type {string} */
    Manufacturer;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Timestamp;
    /** @type {number} */
    SoldToCustomerAcct;
    /** @type {number} */
    BillToCustomerAcct;
    /** @type {string} */
    Model;
    /** @type {string} */
    StLoc;
    /** @type {string} */
    TaxLoc;
    /** @type {string} */
    RefNumber;
    /** @type {string} */
    MasterNumber;
    /** @type {boolean} */
    Invoiced;
    /** @type {DepositInfo[]} */
    Deposits;
    /** @type {string} */
    SoldToCustomerName;
    /** @type {string} */
    BillToCustomerName;
    /** @type {string} */
    ShipToName;
    /** @type {?number} */
    ShipToId;
}
export class ServiceTicketFullDetailsResponse extends BaseResponse {
    /** @param {{Tickets?:TicketInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {TicketInfo[]} */
    Tickets;
}
export class ServiceTicketFullDetailsRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,RefNumber?:string,ChangedDate?:string,Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    Acct;
    /** @type {string} */
    RefNumber;
    /** @type {?string} */
    ChangedDate;
}

JavaScript ServiceTicketFullDetailsRequest DTOs

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

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

<ServiceTicketFullDetailsResponse 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>
  <Tickets>
    <TicketInfo>
      <ApprovedAmount>0</ApprovedAmount>
      <ApprovedDate>0001-01-01T00:00:00</ApprovedDate>
      <BillToCustomerAcct>0</BillToCustomerAcct>
      <BillToCustomerName>String</BillToCustomerName>
      <BilledDate>0001-01-01T00:00:00</BilledDate>
      <Category>0</Category>
      <CategoryDescription>String</CategoryDescription>
      <Contact>String</Contact>
      <Deposits>
        <DepositInfo>
          <Amount>0</Amount>
          <OriginalAmount>0</OriginalAmount>
          <RefNumber>String</RefNumber>
        </DepositInfo>
      </Deposits>
      <Invoiced>false</Invoiced>
      <Item>String</Item>
      <ItemDescription>String</ItemDescription>
      <Manufacturer>String</Manufacturer>
      <MasterNumber>String</MasterNumber>
      <Model>String</Model>
      <Notes>String</Notes>
      <PoNumber>String</PoNumber>
      <RefNumber>String</RefNumber>
      <ReturnAuthorizationNumber>String</ReturnAuthorizationNumber>
      <Services>
        <ServiceInfo>
          <Category>0</Category>
          <CategoryDescription>String</CategoryDescription>
          <Completed>false</Completed>
          <CompletedDate>0001-01-01T00:00:00</CompletedDate>
          <Description>String</Description>
          <Discount>0</Discount>
          <Id>0</Id>
          <Notes>String</Notes>
          <Parts>
            <PartInfo>
              <Category>0</Category>
              <CategoryDescription>String</CategoryDescription>
              <Description>String</Description>
              <Discount>0</Discount>
              <Notes>String</Notes>
              <Price>0</Price>
              <Quantity>0</Quantity>
              <Sku>String</Sku>
              <Total>0</Total>
            </PartInfo>
          </Parts>
          <Quantity>0</Quantity>
          <Rate>0</Rate>
          <Technician>String</Technician>
          <Time>0</Time>
          <TimerActive>false</TimerActive>
          <TimerStartTime>0001-01-01T00:00:00</TimerStartTime>
          <Total>0</Total>
        </ServiceInfo>
      </Services>
      <ShipToId>0</ShipToId>
      <ShipToName>String</ShipToName>
      <SoldToCustomerAcct>0</SoldToCustomerAcct>
      <SoldToCustomerName>String</SoldToCustomerName>
      <StLoc>String</StLoc>
      <Status>String</Status>
      <SubCategory>0</SubCategory>
      <SubCategoryDescription>String</SubCategoryDescription>
      <Subtotal>0</Subtotal>
      <Tax1>0</Tax1>
      <Tax2>0</Tax2>
      <TaxLoc>String</TaxLoc>
      <Terms>0</Terms>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TotalDue>0</TotalDue>
    </TicketInfo>
  </Tickets>
</ServiceTicketFullDetailsResponse>