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;

    /** @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 BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: 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 .xml suffix or ?format=xml

HTTP + XML

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