Foundry API

<back to all web services

RegisterMachineUserRequest

The following routes are available for this service:
POST/users/register/machine
import Foundation
import ServiceStack

public class RegisterMachineUserRequest : PostOperationUnTenanted<RegisterMachineUserResponse>
{
    public var name:String?
    public var timezone:String?

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

    private enum CodingKeys : String, CodingKey {
        case name
        case timezone
    }

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

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

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class RegisterMachineUserResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var userId:String?
    public var apiKey:String?

    required public init(){}
}


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

POST /users/register/machine HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"name":"String","timezone":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userId":"String","apiKey":"String"}