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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceStatus() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Code:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceStatusResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Statuses:ResizeArray<ServiceStatus> = new ResizeArray<ServiceStatus>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///ServiceStatusRequires active-e Service Tickets Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceStatusRequest() = 
        inherit BaseSecureRequest()
        ///<summary>
        ///List of Tickets to be updated. Only used for a POST request.
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="List of Tickets to be updated. Only used for a POST request.", Name="Tickets", ParameterType="query")>]
        member val Tickets:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus.
        ///</summary>
        [<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")>]
        member val NewStatusId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus.
        ///</summary>
        [<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")>]
        member val NewStatus:String = null with get,set

        ///<summary>
        ///New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator.
        ///</summary>
        [<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")>]
        member val NewLocatorId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId.
        ///</summary>
        [<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")>]
        member val NewLocator:String = null with get,set

        ///<summary>
        ///New Master Ticket # to be set to the tickets. Only used for a POST request.
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="New Master Ticket # to be set to the tickets. Only used for a POST request.", Name="NewMasterTicket", ParameterType="query")>]
        member val NewMasterTicket:String = null with get,set

F# 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>