| GET | /account/status | Get account status |
|---|
namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
open System
open System.IO
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> = null 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> = null 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 AccountStatus() =
///<summary>
///The account status (e.g. Unpaid, Active, Expired)
///</summary>
[<ApiMember(Description="The account status (e.g. Unpaid, Active, Expired)")>]
member val Status:String = null with get,set
///<summary>
///The account type (e.g. live, developer, demo)
///</summary>
[<ApiMember(Description="The account type (e.g. live, developer, demo)")>]
member val Type:String = null with get,set
///<summary>
///The account Expiry Date
///</summary>
[<ApiMember(Description="The account Expiry Date")>]
member val ExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The account Expiry Date as a string in ISO 8601 format
///</summary>
[<ApiMember(Description="The account Expiry Date as a string in ISO 8601 format")>]
member val ExpiryDateUniversal:String = null with get,set
///<summary>
///The account balance
///</summary>
[<ApiMember(Description="The account balance")>]
member val Balance:Decimal = new Decimal() with get,set
///<summary>
///The account search credit balance
///</summary>
[<ApiMember(Description="The account search credit balance")>]
member val CreditBalance:Int64 = new Int64() with get,set
///<summary>
///The account DBS credit balance
///</summary>
[<ApiMember(Description="The account DBS credit balance")>]
member val DBSBasicCreditBalance:Int32 = new Int32() with get,set
///<summary>
///The list of enabled products for this account
///</summary>
[<ApiMember(Description="The list of enabled products for this account")>]
member val Products:ResizeArray<String> = null with get,set
///<summary>
///The list of enabled capabilities for this account
///</summary>
[<ApiMember(Description="The list of enabled capabilities for this account")>]
member val Capabilities:ResizeArray<String> = null with get,set
[<AllowNullLiteral>]
type GetAccountStatusData() =
inherit BaseResponse()
///<summary>
///The account status information
///</summary>
[<ApiMember(Description="The account status information")>]
member val AccountStatus:AccountStatus = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetAccountStatusResponse() =
///<summary>
///The response data
///</summary>
[<DataMember>]
[<ApiMember(Description="The response data")>]
member val Data:GetAccountStatusData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Authentication() =
///<summary>
///The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", 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. Can be provided in the request body, or as a header parameter (X-Api-Key)
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")>]
member val ApiUserKey:String = null with get,set
///<summary>
///The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
///</summary>
[<DataMember>]
[<ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")>]
member val UserId: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 GetAccountStatus() =
inherit BaseRequest()
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 /account/status HTTP/1.1 Host: api.simplified.id Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"accountStatus":{"status":"String","type":"String","expiryDate":"\/Date(-62135596800000-0000)\/","expiryDateUniversal":"String","balance":0,"creditBalance":0,"dbsBasicCreditBalance":0,"products":["String"],"capabilities":["String"]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}