Web Service: applicationService

Target Namespace:
https://www.bluemoonforms.com/services/application.php

Port applicationPort Port typeSource code

Location:
https://www.bluemoonforms.com/services/application.php
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. AuthenticateUserDetailSource code
  2. CloseSessionDetailSource code
  3. CreateSessionDetailSource code
  4. DeleteApplicantDetailSource code
  5. FetchPropertyTermsDetailSource code
  6. GetApplicationPDFDetailSource code
  7. GetApplicationXMLDataDetailSource code
  8. GetDefaultApplicationXMLDataDetailSource code
  9. GetFormsCounterDetailSource code
  10. GetRestrictedPDFDetailSource code
  11. ListApplicantsDetailSource code
  12. ListApplicationFieldsDetailSource code
  13. ListApplicationFormsDetailSource code
  14. ListDefaultFieldsDetailSource code
  15. ListFieldsDetailSource code
  16. ListPropertiesDetailSource code
  17. ListUserPrivilegesDetailSource code
  18. SubmitApplicationDetailSource code

Operations

    Port type applicationPortSource code

    1. AuthenticateUser
      Description:
      Authenticates Blue Moon user
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/application.php#AuthenticateUser
      Input:
      AuthenticateUserIn (soap:body, use = literal)Source code
      parameters type AuthenticateUser
      • SerialNumber type string
      • UserId type string
      • Password type string
      Output:
      AuthenticateUserOut (soap:body, use = literal)Source code
      parameters type AuthenticateUserResponse
      • AuthenticateUserResult type boolean
    2. CloseSession
      Description:
      Closes session
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/application.php#CloseSession
      Input:
      CloseSessionIn (soap:body, use = literal)Source code
      parameters type CloseSession
      • SessionId type string
      Output:
      CloseSessionOut (soap:body, use = literal)Source code
      parameters type CloseSessionResponse
      • CloseSessionResult type boolean
    3. CreateSession
      Description:
      Creates new session
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/application.php#CreateSession
      Input:
      CreateSessionIn (soap:body, use = literal)Source code
      parameters type CreateSession
      • SerialNumber type string
      • UserId - nillable; type string
      • Password - nillable; type string
      • skipActiveAccountCheck - nillable; type boolean
      Output:
      CreateSessionOut (soap:body, use = literal)Source code
      parameters type CreateSessionResponse
      • CreateSessionResult type string
    4. DeleteApplicant
      Description:
      Deletes applicant record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/application.php#DeleteApplicant
      Input:
      DeleteApplicantIn (soap:body, use = literal)Source code
      parameters type DeleteApplicant
      • SessionId type string
      • ApplicantId type int
      Output:
      DeleteApplicantOut (soap:body, use = literal)Source code
      parameters type DeleteApplicantResponse
      • DeleteApplicantResult type boolean
    5. FetchPropertyTerms
      Description:
      Fetches property terms PDF from BMS
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/application.php#FetchPropertyTerms
      Input:
      FetchPropertyTermsIn (soap:body, use = literal)Source code
      parameters type FetchPropertyTerms
      • PropertyId type int
      Output:
      FetchPropertyTermsOut (soap:body, use = literal)Source code
      parameters type FetchPropertyTermsResponse
      • FetchPropertyTermsResult type PDF
      • GetApplicationPDF
        Description:
        Public PDF returning interface for FetchPDF Returns byte stream PDF of application form
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#GetApplicationPDF
        Input:
        GetApplicationPDFIn (soap:body, use = literal)Source code
        parameters type GetApplicationPDF
        • SessionId type string
        • ApplicantId type int
        • Preview - nillable; type boolean
        • MaskPII - nillable; type boolean
        Output:
        GetApplicationPDFOut (soap:body, use = literal)Source code
        parameters type GetApplicationPDFResponse
        • GetApplicationPDFResult type base64Binary
      • GetApplicationXMLData
        Description:
        Returns XML application data
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#GetApplicationXMLData
        Input:
        GetApplicationXMLDataIn (soap:body, use = literal)Source code
        parameters type GetApplicationXMLData
        • SessionId type string
        • ApplicantId type int
        • MaskPII - nillable; type boolean
        Output:
        GetApplicationXMLDataOut (soap:body, use = literal)Source code
        parameters type GetApplicationXMLDataResponse
        • GetApplicationXMLDataResult type string
      • GetDefaultApplicationXMLData
        Description:
        Returns default XML application data
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#GetDefaultApplicationXMLData
        Input:
        GetDefaultApplicationXMLDataIn (soap:body, use = literal)Source code
        parameters type GetDefaultApplicationXMLData
        • SessionId type string
        • PropertyId - nillable; type int
        Output:
        GetDefaultApplicationXMLDataOut (soap:body, use = literal)Source code
        parameters type GetDefaultApplicationXMLDataResponse
        • GetDefaultApplicationXMLDataResult type string
      • GetFormsCounter
        Description:
        Returns current forms counter
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#GetFormsCounter
        Input:
        GetFormsCounterIn (soap:body, use = literal)Source code
        parameters type GetFormsCounter
        • SessionId type string
        Output:
        GetFormsCounterOut (soap:body, use = literal)Source code
        parameters type GetFormsCounterResponse
        • GetFormsCounterResult type anyType
      • GetRestrictedPDF
        Description:
        Returns byte stream PDF of application documents
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#GetRestrictedPDF
        Input:
        GetRestrictedPDFIn (soap:body, use = literal)Source code
        parameters type GetRestrictedPDF
        • SessionId type string
        • PropertyId - nillable; type int
        • ApplicationForms - nillable; type ArrayOfFormshort
          • item - optional, unbounded; type FormShort
            • Id - nillable; type string
        • CustomApplicationForms - nillable; type ArrayOfFormshort
          • item - optional, unbounded; type FormShort
            • Id - nillable; type string
        • FormXMLData - nillable; type string
        • Preview - nillable; type boolean
        Output:
        GetRestrictedPDFOut (soap:body, use = literal)Source code
        parameters type GetRestrictedPDFResponse
        • GetRestrictedPDFResult type base64Binary
      • ListApplicants
        Description:
        Returns info for all applicants matching specified criteria
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListApplicants
        Input:
        ListApplicantsIn (soap:body, use = literal)Source code
        parameters type ListApplicants
        • SessionId type string
        • PropertyId - nillable; type int
        • ApplicantLastName - nillable; type string
        • ApplicantFirstName - nillable; type string
        • StartDate - nillable; type string
        • EndDate - nillable; type string
        Output:
        ListApplicantsOut (soap:body, use = literal)Source code
        parameters type ListApplicantsResponse
        • ListApplicantsResult type ArrayOfApplicant
          • item - optional, unbounded; type Applicant
            • Id - nillable; type int
            • ApplicationDate - nillable; type string
            • FirstName - nillable; type string
            • LastName - nillable; type string
      • ListApplicationFields
        Description:
        Returns info for fields available on non-batch-printable application form for current license
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListApplicationFields
        Input:
        ListApplicationFieldsIn (soap:body, use = literal)Source code
        parameters type ListApplicationFields
        • SessionId type string
        • Form type FormShort
          • Id - nillable; type string
        • PropertyId - nillable; type int
        Output:
        ListApplicationFieldsOut (soap:body, use = literal)Source code
        parameters type ListApplicationFieldsResponse
        • ListApplicationFieldsResult type ArrayOfField
          • item - optional, unbounded; type Field
            • Name - nillable; type string
            • Type - nillable; type string
            • Length - nillable; type string
            • Required - nillable; type boolean
      • ListApplicationForms
        Description:
        Returns info for application forms available for current license
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListApplicationForms
        Input:
        ListApplicationFormsIn (soap:body, use = literal)Source code
        parameters type ListApplicationForms
        • SessionId type string
        • PropertyId - nillable; type int
        Output:
        ListApplicationFormsOut (soap:body, use = literal)Source code
        parameters type ListApplicationFormsResponse
        • ListApplicationFormsResult type ArrayOfForm
          • item - optional, unbounded; type Form
            • Id - nillable; type string
            • Title - nillable; type string
            • Copies - nillable; type int
            • Cost - nillable; type anyType
            • PageSize - nillable; type string
            • Language - nillable; type string
            • PageCount - nillable; type int
            • FormSection - nillable; type string
            • Status - nillable; type string
            • FormType - nillable; type string
      • ListDefaultFields
        Description:
        Returns info for fields available on rental application form for current license which can auto-populate from Default Lease template
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListDefaultFields
        Input:
        ListDefaultFieldsIn (soap:body, use = literal)Source code
        parameters type ListDefaultFields
        • SessionId type string
        • PropertyId - nillable; type int
        Output:
        ListDefaultFieldsOut (soap:body, use = literal)Source code
        parameters type ListDefaultFieldsResponse
        • ListDefaultFieldsResult type ArrayOfField
          • item - optional, unbounded; type Field
            • Name - nillable; type string
            • Type - nillable; type string
            • Length - nillable; type string
            • Required - nillable; type boolean
      • ListFields
        Description:
        Returns info for fields available on rental application form for current license
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListFields
        Input:
        ListFieldsIn (soap:body, use = literal)Source code
        parameters type ListFields
        • SessionId type string
        • PropertyId - nillable; type int
        Output:
        ListFieldsOut (soap:body, use = literal)Source code
        parameters type ListFieldsResponse
        • ListFieldsResult type ArrayOfField
          • item - optional, unbounded; type Field
            • Name - nillable; type string
            • Type - nillable; type string
            • Length - nillable; type string
            • Required - nillable; type boolean
      • ListProperties
        Description:
        Returns info for all properties contained by current license
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListProperties
        Input:
        ListPropertiesIn (soap:body, use = literal)Source code
        parameters type ListProperties
        • SessionId type string
        Output:
        ListPropertiesOut (soap:body, use = literal)Source code
        parameters type ListPropertiesResponse
        • ListPropertiesResult type ArrayOfProperty
          • item - optional, unbounded; type Property
            • Id - nillable; type int
            • Name - nillable; type string
            • Type - nillable; type string
      • ListUserPrivileges
        Description:
        Returns account privileges for current user
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#ListUserPrivileges
        Input:
        ListUserPrivilegesIn (soap:body, use = literal)Source code
        parameters type ListUserPrivileges
        • SessionId type string
        Output:
        ListUserPrivilegesOut (soap:body, use = literal)Source code
        parameters type ListUserPrivilegesResponse
        • ListUserPrivilegesResult type ArrayOfPrivilege
          • item - optional, unbounded; type Privilege
            • Name - nillable; type string
            • Restricted - nillable; type boolean
      • SubmitApplication
        Description:
        Creates new application record Returns unique ApplicantId
        Operation type:
        Request-response. The endpoint receives a message, and sends a correlated message.
        SOAP action:
        https://www.bluemoonforms.com/services/application.php#SubmitApplication
        Input:
        SubmitApplicationIn (soap:body, use = literal)Source code
        parameters type SubmitApplication
        • SessionId type string
        • ApplicationXMLData type string
        • PropertyId - nillable; type int
        Output:
        SubmitApplicationOut (soap:body, use = literal)Source code
        parameters type SubmitApplicationResponse
        • SubmitApplicationResult type int

    WSDL source code

    <?xml version="1.0"?>
    <definitions name="application" targetNamespace="https://www.bluemoonforms.com/services/application.php"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap-enc="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:tns="https://www.bluemoonforms.com/services/application.php"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    >
    <types>
    <xsd:schema targetNamespace="https://www.bluemoonforms.com/services/application.php"></xsd:schema>
    </types>
    <portType name="applicationPort">
    <operation name="GetApplicationPDF">
    <documentation>Public PDF returning interface for FetchPDF Returns byte stream PDF of application form</documentation>
    </operation>
    <operation name="ListApplicants">
    <documentation>Returns info for all applicants matching specified criteria</documentation>
    </operation>
    <operation name="ListDefaultFields">
    <documentation>Returns info for fields available on rental application form for current license which can auto-populate from Default Lease template</documentation>
    </operation>
    <operation name="ListFields">
    <documentation>Returns info for fields available on rental application form for current license</documentation>
    </operation>
    <operation name="ListApplicationFields">
    <documentation>Returns info for fields available on non-batch-printable application form for current license</documentation>
    </operation>
    <operation name="ListProperties">
    <documentation>Returns info for all properties contained by current license</documentation>
    </operation>
    </portType>
    <binding name="applicationBinding" type="tns:applicationPort"></binding>
    </definitions>

    About wsdl-viewer.xsl

    This document was generated by libxslt XSLT engine. The engine processed the WSDL in XSLT 1.0 compliant mode.
    This page has been generated by wsdl-viewer.xsl, version 3.1.01
    Author: tomi vanek
    Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.

    The transformation was inspired by the article
    Uche Ogbuji: WSDL processing with XSLT