MBMMFAutoEnrol

ValidateDetailsRequest

The following routes are available for this service:
POST	/ValidateDetails/

# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class ValidateDetailsResponse
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :bpid
    # @return [TrueClass]
    attr_accessor :is_valid
    # @return [TrueClass]
    attr_accessor :is_locked
    # @return [Integer]
    attr_accessor :attempts_remaining
    # @return [String]
    attr_accessor :error

    def self.properties
        {
            bpid: { name: 'bpid' },
            is_valid: { name: 'isValid' },
            is_locked: { name: 'isLocked' },
            attempts_remaining: { name: 'attemptsRemaining' },
            error: { name: 'error' },
        }
    end

end

class ValidateDetailsRequest
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :guid
    # @return [String]
    attr_accessor :postcode
    # @return [String]
    attr_accessor :number4
    # @return [String]
    attr_accessor :email
    # @return [String]
    attr_accessor :email_confirm
    # @return [TrueClass]
    attr_accessor :is_signed_up
    # @return [TrueClass]
    attr_accessor :is_privacy_checked

    def self.properties
        {
            guid: { name: 'guid' },
            postcode: { name: 'postcode' },
            number4: { name: 'number4' },
            email: { name: 'email' },
            email_confirm: { name: 'emailConfirm' },
            is_signed_up: { name: 'isSignedUp' },
            is_privacy_checked: { name: 'isPrivacyChecked' },
        }
    end

    def response_type() = ValidateDetailsResponse
    def get_type_name() = 'ValidateDetailsRequest'
end

Ruby ValidateDetailsRequest 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.

POST /ValidateDetails/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBMMFAutoEnrol.ServiceInterface.Services.GetDetails">
  <Email>String</Email>
  <EmailConfirm>String</EmailConfirm>
  <GUID>00000000-0000-0000-0000-000000000000</GUID>
  <IsPrivacyChecked>false</IsPrivacyChecked>
  <IsSignedUp>false</IsSignedUp>
  <Number4>String</Number4>
  <Postcode>String</Postcode>
</ValidateDetailsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ValidateDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBMMFAutoEnrol.ServiceInterface.Services.GetDetails">
  <AttemptsRemaining>0</AttemptsRemaining>
  <BPID>0</BPID>
  <Error>String</Error>
  <IsLocked>false</IsLocked>
  <IsValid>false</IsValid>
</ValidateDetailsResponse>