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

Namespace Global

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''ServiceStatusRequires active-e Service Tickets Service
        '''</Summary>
        <DataContract>
        Public Partial Class ServiceStatusRequest
            Inherits BaseSecureRequest
            Public Sub New()
                Tickets = New List(Of String)
            End Sub

            '''<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 Overridable Property Tickets As List(Of String)

            '''<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 Overridable Property NewStatusId As Nullable(Of Long)

            '''<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 Overridable Property NewStatus As String

            '''<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 Overridable Property NewLocatorId As Nullable(Of Long)

            '''<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 Overridable Property NewLocator As String

            '''<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 Overridable Property NewMasterTicket As String
        End Class

        <DataContract>
        Public Partial Class ServiceStatusResponse
            Inherits BaseResponse
            Public Sub New()
                Statuses = New List(Of ServiceStatus)
            End Sub

            <DataMember>
            Public Overridable Property Statuses As List(Of ServiceStatus)

            <DataContract>
            Public Partial Class ServiceStatus
                <DataMember>
                Public Overridable Property Id As Long

                <DataMember>
                Public Overridable Property Status As String

                <DataMember>
                Public Overridable Property Description As String

                <DataMember>
                Public Overridable Property Code As String
            End Class
        End Class
    End Namespace
End Namespace

VB.NET 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>