Sanctions Search API: v2

<back to all web services

AddSubUser

Account
The following routes are available for this service:
POST/subusers/createCreate a sub user
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Account;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
{
    [DataContract]
    public partial class AddSubUser
        : BaseRequest
    {
        [DataMember]
        public virtual AddSubUserRequest Request { get; set; }
    }

    public partial class AddSubUserData
        : BaseResponse
    {
        ///<summary>
        ///The sub user
        ///</summary>
        [ApiMember(Description="The sub user")]
        public virtual SubUser SubUser { get; set; }
    }

    public partial class AddSubUserRequest
    {
        public virtual string UserName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Email { get; set; }
        public virtual bool IsAdmin { get; set; }
        public virtual bool CanResolveSearches { get; set; }
        public virtual bool CanDeleteSearches { get; set; }
        public virtual bool SendWelcomeEmail { get; set; }
    }

    [DataContract]
    public partial class AddSubUserResponse
    {
        ///<summary>
        ///The response data
        ///</summary>
        [DataMember]
        [ApiMember(Description="The response data")]
        public virtual AddSubUserData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfUserNames
        : List<string>
    {
    }

    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }
    }

    public partial class SubUser
    {
        ///<summary>
        ///Is this user the main user (i.e. the user who created the account)
        ///</summary>
        [ApiMember(Description="Is this user the main user (i.e. the user who created the account)")]
        public virtual bool IsMainUser { get; set; }

        ///<summary>
        ///The sub user's id (GUID)
        ///</summary>
        [ApiMember(Description="The sub user's id (GUID)")]
        public virtual Guid UserId { get; set; }

        ///<summary>
        ///The sub user's UserName (i.e. the sign-in username)
        ///</summary>
        [ApiMember(Description="The sub user's UserName (i.e. the sign-in username)")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///The sub user's name
        ///</summary>
        [ApiMember(Description="The sub user's name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The sub user's email address
        ///</summary>
        [ApiMember(Description="The sub user's email address")]
        public virtual string Email { get; set; }

        ///<summary>
        ///Does this sub user have admin privileges, such as managing purchases and sub users
        ///</summary>
        [ApiMember(Description="Does this sub user have admin privileges, such as managing purchases and sub users")]
        public virtual bool IsAdmin { get; set; }

        ///<summary>
        ///Can this sub user resolve searches (UpdateSearch) they have access to
        ///</summary>
        [ApiMember(Description="Can this sub user resolve searches (UpdateSearch) they have access to")]
        public virtual bool CanResolveSearches { get; set; }

        ///<summary>
        ///Can this sub user delete searches (DeleteSearch) they have access to
        ///</summary>
        [ApiMember(Description="Can this sub user delete searches (DeleteSearch) they have access to")]
        public virtual bool CanDeleteSearches { get; set; }

        ///<summary>
        ///The user names for which searches will be made available to the sub user
        ///</summary>
        [ApiMember(Description="The user names for which searches will be made available to the sub user")]
        public virtual ArrayOfUserNames Permissions { get; set; }
    }

}

C# 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"}}}}