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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
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 ServiceStatus {
    /** @param {{Id?:number,Status?:string,Description?:string,Code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Status;
    /** @type {string} */
    Description;
    /** @type {string} */
    Code;
}
export class ServiceStatusResponse extends BaseResponse {
    /** @param {{Statuses?:ServiceStatus[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ServiceStatus[]} */
    Statuses;
}
export class ServiceStatusRequest extends BaseSecureRequest {
    /** @param {{Tickets?:string[],NewStatusId?:number,NewStatus?:string,NewLocatorId?:number,NewLocator?:string,NewMasterTicket?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description List of Tickets to be updated. Only used for a POST request. */
    Tickets;
    /**
     * @type {?number}
     * @description New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus. */
    NewStatusId;
    /**
     * @type {string}
     * @description New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus. */
    NewStatus;
    /**
     * @type {?number}
     * @description New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator. */
    NewLocatorId;
    /**
     * @type {string}
     * @description New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId. */
    NewLocator;
    /**
     * @type {string}
     * @description New Master Ticket # to be set to the tickets. Only used for a POST request. */
    NewMasterTicket;
}

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

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

{"Tickets":["String"],"NewStatusId":0,"NewStatus":"String","NewLocatorId":0,"NewLocator":"String","NewMasterTicket":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Statuses":[{"Id":0,"Status":"String","Description":"String","Code":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}