MBMMFAutoEnrol

<back to all web services

PutEmailAdd_RegRequest

Requires Authentication
The following routes are available for this service:
PUT/PutEmailAddress_RegRequestDate/
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class PutEmailAdd_RegResponse
    include ServiceStack::DTO

    # @return [TrueClass]
    attr_accessor :success
    # @return [TrueClass]
    attr_accessor :already_registered
    # @return [String]
    attr_accessor :error

    def self.properties
        {
            success: { name: 'success' },
            already_registered: { name: 'alreadyRegistered' },
            error: { name: 'error' },
        }
    end

end

class PutEmailAdd_RegRequest
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :bpid
    # @return [String]
    attr_accessor :email_address

    def self.properties
        {
            bpid: { name: 'bpid' },
            email_address: { name: 'emailAddress' },
        }
    end

    def response_type() = PutEmailAdd_RegResponse
    def get_type_name() = 'PutEmailAdd_RegRequest'
end

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

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

<PutEmailAdd_RegRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBMMFAutoEnrol.ServiceInterface.Services.PutEmailAdd_RegRequestDate">
  <BPID>0</BPID>
  <EmailAddress>String</EmailAddress>
</PutEmailAdd_RegRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutEmailAdd_RegResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBMMFAutoEnrol.ServiceInterface.Services.PutEmailAdd_RegRequestDate">
  <AlreadyRegistered>false</AlreadyRegistered>
  <Error>String</Error>
  <Success>false</Success>
</PutEmailAdd_RegResponse>