Billhighway Cloud API

<back to all web services

IvrStatusRequest

The following routes are available for this service:
GET/ivr/status
import Foundation
import ServiceStack

public class IvrStatusRequest : IvrStatusRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class IvrStatusResponse : IvrStatusResponse, IHaveErrorField
{
    public var status:String?
    public var message:String?
    // @ApiMember(ExcludeInSchema=true)
    public var isError:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case status
        case message
        case isError
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        status = try container.decodeIfPresent(String.self, forKey: .status)
        message = try container.decodeIfPresent(String.self, forKey: .message)
        isError = try container.decodeIfPresent(Bool.self, forKey: .isError)
    }

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


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

GET /ivr/status HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IvrStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.IVR">
  <Message xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</Message>
  <Status xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</Status>
</IvrStatusResponse>