| GET | /subusers/list | Get all sub users |
|---|
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 GetSubUsersData() =
inherit BaseResponse()
///<summary>
///The list of sub users
///</summary>
[<ApiMember(Description="The list of sub users")>]
member val SubUsers:ResizeArray<SubUser> = new ResizeArray<SubUser>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetSubUsersResponse() =
///<summary>
///The response data
///</summary>
[<DataMember>]
[<ApiMember(Description="The response data")>]
member val Data:GetSubUsersData = 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
[<DataContract>]
[<AllowNullLiteral>]
type GetSubUsers() =
inherit BaseRequest()
///<summary>
///If this is 'True' the main user will be included in the list of sub users
///</summary>
[<DataMember>]
[<ApiMember(Description="If this is 'True' the main user will be included in the list of sub users", ParameterType="query")>]
member val IncludeMainUser:Boolean = new Boolean() with get,set
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /subusers/list HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"subUsers":[{"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"}}}}