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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///ServiceStatusRequires active-e Service Tickets Service
    ///</summary>
    [DataContract]
    public partial class ServiceStatusRequest
        : BaseSecureRequest
    {
        public ServiceStatusRequest()
        {
            Tickets = new List<string>{};
        }

        ///<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")]
        public virtual List<string> Tickets { 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")]
        public virtual long? NewStatusId { 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")]
        public virtual string NewStatus { 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")]
        public virtual long? NewLocatorId { 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")]
        public virtual string NewLocator { 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")]
        public virtual string NewMasterTicket { get; set; }
    }

    [DataContract]
    public partial class ServiceStatusResponse
        : BaseResponse
    {
        public ServiceStatusResponse()
        {
            Statuses = new List<ServiceStatus>{};
        }

        [DataMember]
        public virtual List<ServiceStatus> Statuses { get; set; }
        [DataContract]
        public partial class ServiceStatus
        {
            [DataMember]
            public virtual long Id { get; set; }

            [DataMember]
            public virtual string Status { get; set; }

            [DataMember]
            public virtual string Description { get; set; }

            [DataMember]
            public virtual string Code { get; set; }
        }

    }

}

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