AIM Web Services

<back to all web services

ServiceStatusRequest

ServiceStatus
Requires active-e Service Tickets Service

The following routes are available for this service:
GET, POST/api/ServiceStatus

// @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 ServiceStatus
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Status: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Code: string;

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

// @DataContract
export class ServiceStatusResponse extends BaseResponse
{
    // @DataMember
    public Statuses: ServiceStatus[];

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

/** @description ServiceStatusRequires active-e Service Tickets Service */
// @DataContract
export class ServiceStatusRequest extends BaseSecureRequest
{
    /** @description List of Tickets to be updated. Only used for a POST request. */
    // @DataMember
    // @ApiMember(Description="List of Tickets to be updated. Only used for a POST request.", Name="Tickets", ParameterType="query")
    public Tickets: string[];

    /** @description New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus. */
    // @DataMember
    // @ApiMember(Description="New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus.", Name="NewStatusId", ParameterType="query")
    public NewStatusId?: number;

    /** @description New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus. */
    // @DataMember
    // @ApiMember(Description="New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus.", Name="NewStatus", ParameterType="query")
    public NewStatus: string;

    /** @description New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator. */
    // @DataMember
    // @ApiMember(Description="New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator.", Name="NewLocatorId", ParameterType="query")
    public NewLocatorId?: number;

    /** @description New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId. */
    // @DataMember
    // @ApiMember(Description="New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId.", Name="NewLocator", ParameterType="query")
    public NewLocator: string;

    /** @description New Master Ticket # to be set to the tickets. Only used for a POST request. */
    // @DataMember
    // @ApiMember(Description="New Master Ticket # to be set to the tickets. Only used for a POST request.", Name="NewMasterTicket", ParameterType="query")
    public NewMasterTicket: string;

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

TypeScript ServiceStatusRequest 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.

POST /api/ServiceStatus HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ServiceStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <NewLocator>String</NewLocator>
  <NewLocatorId>0</NewLocatorId>
  <NewMasterTicket>String</NewMasterTicket>
  <NewStatus>String</NewStatus>
  <NewStatusId>0</NewStatusId>
  <Tickets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Tickets>
</ServiceStatusRequest>

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

<ServiceStatusResponse 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>
  <Statuses>
    <ServiceStatusResponse.ServiceStatus>
      <Code>String</Code>
      <Description>String</Description>
      <Id>0</Id>
      <Status>String</Status>
    </ServiceStatusResponse.ServiceStatus>
  </Statuses>
</ServiceStatusResponse>