sfgboxapi

<back to all web services

ContactUs

Requires Authentication
The following routes are available for this service:
POST/contactus
import Foundation
import ServiceStack

public class ContactUs : Codable
{
    // @Validate(Validator="[NotNull,NotEmpty]")
    public var name:String

    // @Validate(Validator="Email")
    public var eMail:String

    // @Validate(Validator="[NotNull,NotEmpty]")
    public var message:String

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class UserAuth : Codable
{
    public var id:Int
    public var userName:String
    public var email:String
    public var primaryEmail:String
    public var phoneNumber:String
    public var firstName:String
    public var lastName:String
    public var displayName:String
    public var company:String
    public var birthDate:Date?
    public var birthDateRaw:String
    public var address:String
    public var address2:String
    public var city:String
    public var state:String
    public var country:String
    public var culture:String
    public var fullName:String
    public var gender:String
    public var language:String
    public var mailAddress:String
    public var nickname:String
    public var postalCode:String
    public var timeZone:String
    public var salt:String
    public var passwordHash:String
    public var digestHa1Hash:String
    public var roles:[String] = []
    public var permissions:[String] = []
    public var createdDate:Date
    public var modifiedDate:Date
    public var invalidLoginAttempts:Int
    public var lastLoginAttempt:Date?
    public var lockedDate:Date?
    public var recoveryToken:String
    public var refId:Int?
    public var refIdStr:String
    public var meta:[String:String] = [:]

    required public init(){}
}

Swift ContactUs DTOs

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

HTTP + OTHER

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

POST /contactus HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"name":"String","eMail":"String","message":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"id":0,"userName":"String","email":"String","primaryEmail":"String","phoneNumber":"String","firstName":"String","lastName":"String","displayName":"String","company":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","fullName":"String","gender":"String","language":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","roles":["String"],"permissions":["String"],"createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","recoveryToken":"String","refId":0,"refIdStr":"String","meta":{"String":"String"}}