Sanctions Search API: v2

<back to all web services

GetEulaStatus

Account
The following routes are available for this service:
GET/account/eulaGet the account EULA & status
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 GetEulaStatusData() = 
        inherit BaseResponse()
        member val TermsAndConditions:String = null with get,set
        member val PrivacyPolicy:String = null with get,set
        member val AgreeToContact:Boolean = new Boolean() with get,set
        member val AgreeToContactInfo:String = null with get,set
        member val AgreeToContactDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgreeToTerms:Boolean = new Boolean() with get,set
        member val AgreeToTermsInfo:String = null with get,set
        member val AgreeToTermsDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgreeToDataProtection:Boolean = new Boolean() with get,set
        member val AgreeToDataProtectionInfo:String = null with get,set
        member val AgreeToDataProtectionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetEulaStatusResponse() = 
        [<DataMember>]
        member val Data:GetEulaStatusData = 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 GetEulaStatus() = 
        inherit BaseRequest()
        ///<summary>
        ///If this is specified, the information will be for the specified sub user, otherwise it will be for the main user account
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="If this is specified, the information will be for the specified sub user, otherwise it will be for the main user account")>]
        member val SubUserName:String = null with get,set

F# GetEulaStatus DTOs

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

HTTP + XML

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

GET /account/eula HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEulaStatusResponse 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>
    <AgreeToContact>false</AgreeToContact>
    <AgreeToContactDate>0001-01-01T00:00:00</AgreeToContactDate>
    <AgreeToContactInfo>String</AgreeToContactInfo>
    <AgreeToDataProtection>false</AgreeToDataProtection>
    <AgreeToDataProtectionDate>0001-01-01T00:00:00</AgreeToDataProtectionDate>
    <AgreeToDataProtectionInfo>String</AgreeToDataProtectionInfo>
    <AgreeToTerms>false</AgreeToTerms>
    <AgreeToTermsDate>0001-01-01T00:00:00</AgreeToTermsDate>
    <AgreeToTermsInfo>String</AgreeToTermsInfo>
    <PrivacyPolicy>String</PrivacyPolicy>
    <TermsAndConditions>String</TermsAndConditions>
  </Data>
</GetEulaStatusResponse>