Antel Merchandiser App API

<back to all web services

Test

The following routes are available for this service:
GET/testSimple test method to confirm the services are working
import Foundation
import ServiceStack

public class Test : Codable
{
    /**
    * An email address a test email will be sent to
    */
    // @ApiMember(Description="An email address a test email will be sent to")
    public var smtp:String?

    required public init(){}
}

public class TestResponse : Codable
{
    public var environment:String?
    public var tests:[String:TestResult] = [:]
    public var wasSuccessful:Bool?
    public var db:String?
    public var debugMode:Bool?
    public var serverGC:Bool?

    required public init(){}
}

public class TestResult : Codable
{
    public var wasSuccessful:Bool?
    public var Description:String?

    required public init(){}
}


Swift Test DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /test HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Environment":"String","Tests":{"String":{"WasSuccessful":false,"Description":"String"}},"WasSuccessful":false,"DB":"String","DebugMode":false,"ServerGC":false}