Sanctions Search API: v2

AddSubUser

Account

The following routes are available for this service:
POST	/subusers/create	Create a sub user

import Foundation
import ServiceStack

// @DataContract
public class AddSubUser : BaseRequest
{
    // @DataMember
    public var request:AddSubUserRequest

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

    private enum CodingKeys : String, CodingKey {
        case request
    }

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

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

// @DataContract
public class BaseRequest : IBaseRequest, Codable
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public var authentication:Authentication

    required public init(){}
}

// @DataContract
public class Authentication : Codable
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserId:String

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserKey:String

    required public init(){}
}

public class AddSubUserRequest : Codable
{
    public var userName:String
    public var name:String
    public var email:String
    public var isAdmin:Bool
    public var canResolveSearches:Bool
    public var canDeleteSearches:Bool
    public var sendWelcomeEmail:Bool

    required public init(){}
}

// @DataContract
public class AddSubUserResponse : Codable
{
    /**
    * The response data
    */
    // @DataMember
    // @ApiMember(Description="The response data")
    public var data:AddSubUserData

    required public init(){}
}

public class AddSubUserData : BaseResponse
{
    /**
    * The sub user
    */
    // @ApiMember(Description="The sub user")
    public var subUser:SubUser

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

    private enum CodingKeys : String, CodingKey {
        case subUser
    }

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

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

public class BaseResponse : IBaseDataResponse, IHasResponseStatus, Codable
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    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 SubUser : Codable
{
    /**
    * Is this user the main user (i.e. the user who created the account)
    */
    // @ApiMember(Description="Is this user the main user (i.e. the user who created the account)")
    public var isMainUser:Bool

    /**
    * The sub user's id (GUID)
    */
    // @ApiMember(Description="The sub user's id (GUID)")
    public var userId:String

    /**
    * The sub user's UserName (i.e. the sign-in username)
    */
    // @ApiMember(Description="The sub user's UserName (i.e. the sign-in username)")
    public var userName:String

    /**
    * The sub user's name
    */
    // @ApiMember(Description="The sub user's name")
    public var name:String

    /**
    * The sub user's email address
    */
    // @ApiMember(Description="The sub user's email address")
    public var email:String

    /**
    * Does this sub user have admin privileges, such as managing purchases and sub users
    */
    // @ApiMember(Description="Does this sub user have admin privileges, such as managing purchases and sub users")
    public var isAdmin:Bool

    /**
    * Can this sub user resolve searches (UpdateSearch) they have access to
    */
    // @ApiMember(Description="Can this sub user resolve searches (UpdateSearch) they have access to")
    public var canResolveSearches:Bool

    /**
    * Can this sub user delete searches (DeleteSearch) they have access to
    */
    // @ApiMember(Description="Can this sub user delete searches (DeleteSearch) they have access to")
    public var canDeleteSearches:Bool

    /**
    * The user names for which searches will be made available to the sub user
    */
    // @ApiMember(Description="The user names for which searches will be made available to the sub user")
    public var permissions:ArrayOfUserNames

    required public init(){}
}

public class ArrayOfUserNames : List<String>
{
    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)
    }
}

Swift AddSubUser DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /subusers/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"userName":"String","name":"String","email":"String","isAdmin":false,"canResolveSearches":false,"canDeleteSearches":false,"sendWelcomeEmail":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"subUser":{"isMainUser":false,"userName":"String","name":"String","email":"String","isAdmin":false,"canResolveSearches":false,"canDeleteSearches":false,"permissions":["String"]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}