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
import Foundation
import ServiceStack

/**
* ServiceStatusRequires active-e Service Tickets Service
*/
// @DataContract
public class ServiceStatusRequest : BaseSecureRequest
{
    /**
    * 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 var tickets:[String] = []

    /**
    * 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 var newStatusId:Int?

    /**
    * 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 var newStatus:String

    /**
    * 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 var newLocatorId:Int?

    /**
    * 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 var newLocator:String

    /**
    * 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 var newMasterTicket:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case tickets
        case newStatusId
        case newStatus
        case newLocatorId
        case newLocator
        case newMasterTicket
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        tickets = try container.decodeIfPresent([String].self, forKey: .tickets) ?? []
        newStatusId = try container.decodeIfPresent(Int.self, forKey: .newStatusId)
        newStatus = try container.decodeIfPresent(String.self, forKey: .newStatus)
        newLocatorId = try container.decodeIfPresent(Int.self, forKey: .newLocatorId)
        newLocator = try container.decodeIfPresent(String.self, forKey: .newLocator)
        newMasterTicket = try container.decodeIfPresent(String.self, forKey: .newMasterTicket)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if tickets.count > 0 { try container.encode(tickets, forKey: .tickets) }
        if newStatusId != nil { try container.encode(newStatusId, forKey: .newStatusId) }
        if newStatus != nil { try container.encode(newStatus, forKey: .newStatus) }
        if newLocatorId != nil { try container.encode(newLocatorId, forKey: .newLocatorId) }
        if newLocator != nil { try container.encode(newLocator, forKey: .newLocator) }
        if newMasterTicket != nil { try container.encode(newMasterTicket, forKey: .newMasterTicket) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class ServiceStatusResponse : BaseResponse
{
    // @DataMember
    public var statuses:[ServiceStatus] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case statuses
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        statuses = try container.decodeIfPresent([ServiceStatus].self, forKey: .statuses) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if statuses.count > 0 { try container.encode(statuses, forKey: .statuses) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class ServiceStatus : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var status:String

    // @DataMember
    public var Description:String

    // @DataMember
    public var code:String

    required public init(){}
}

Swift 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>