| Create a sub user |
namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ResponseError() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val FieldName:String = null with get,set
[<DataMember(Order=3)>]
member val Message:String = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type ArrayOfResponseError() =
inherit ResizeArray<ResponseError>()
[<DataContract>]
[<AllowNullLiteral>]
type ResponseStatus() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val Message:String = null with get,set
[<DataMember(Order=3)>]
member val StackTrace:String = null with get,set
[<DataMember(Order=4)>]
member val Errors:ArrayOfResponseError = null with get,set
[<DataMember(Order=5)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///The status of the response
///</summary>
[<ApiMember(Description="The status of the response")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type ArrayOfUserNames() =
inherit ResizeArray<String>()
[<AllowNullLiteral>]
type 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)")>]
member val IsMainUser:Boolean = new Boolean() with get,set
///<summary>
///The sub user's id (GUID)
///</summary>
[<ApiMember(Description="The sub user's id (GUID)")>]
member val UserId:Guid = new Guid() with 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)")>]
member val UserName:String = null with get,set
///<summary>
///The sub user's name
///</summary>
[<ApiMember(Description="The sub user's name")>]
member val Name:String = null with get,set
///<summary>
///The sub user's email address
///</summary>
[<ApiMember(Description="The sub user's email address")>]
member val Email:String = null with 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")>]
member val IsAdmin:Boolean = new Boolean() with 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")>]
member val CanResolveSearches:Boolean = new Boolean() with 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")>]
member val CanDeleteSearches:Boolean = new Boolean() with 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")>]
member val Permissions:ArrayOfUserNames = null with get,set
[<AllowNullLiteral>]
type AddSubUserData() =
inherit BaseResponse()
///<summary>
///The sub user
///</summary>
[<ApiMember(Description="The sub user")>]
member val SubUser:SubUser = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddSubUserResponse() =
///<summary>
///The response data
///</summary>
[<DataMember>]
[<ApiMember(Description="The response data")>]
member val Data:AddSubUserData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiUserId:String = null with 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")>]
member val ApiUserKey:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///The authentication credentials
///</summary>
[<DataMember>]
[<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
member val Authentication:Authentication = null with get,set
[<AllowNullLiteral>]
type AddSubUserRequest() =
member val UserName:String = null with get,set
member val Name:String = null with get,set
member val Email:String = null with get,set
member val IsAdmin:Boolean = new Boolean() with get,set
member val CanResolveSearches:Boolean = new Boolean() with get,set
member val CanDeleteSearches:Boolean = new Boolean() with get,set
member val SendWelcomeEmail:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddSubUser() =
inherit BaseRequest()
[<DataMember>]
member val Request:AddSubUserRequest = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: AddSubUser
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddSubUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<CanDeleteSearches>false</CanDeleteSearches>
<CanResolveSearches>false</CanResolveSearches>
<Email>String</Email>
<IsAdmin>false</IsAdmin>
<Name>String</Name>
<SendWelcomeEmail>false</SendWelcomeEmail>
<UserName>String</UserName>
</Request>
</AddSubUser>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddSubUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<SubUser>
<CanDeleteSearches>false</CanDeleteSearches>
<CanResolveSearches>false</CanResolveSearches>
<Email>String</Email>
<IsAdmin>false</IsAdmin>
<IsMainUser>false</IsMainUser>
<Name>String</Name>
<Permissions>
<UserName>String</UserName>
</Permissions>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>String</UserName>
</SubUser>
</Data>
</AddSubUserResponse>
</soap:Body>
</soap:Envelope>