Web Service: leaseService

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

Port leasePort Port typeSource code

Location:
https://www.bluemoonforms.com/services/lease.php
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. AmendRoommatesDetailSource code
  2. AuthenticateUserDetailSource code
  3. CloseSessionDetailSource code
  4. CreateLeaseDetailSource code
  5. CreateSessionDetailSource code
  6. DeleteEsignatureDetailSource code
  7. DeleteLeaseDetailSource code
  8. EditLeaseDetailSource code
  9. EditRenewalDetailSource code
  10. ExecuteLeaseDetailSource code
  11. GetDefaultLeaseXMLDataDetailSource code
  12. GetDefaultRenewalXMLDataDetailSource code
  13. GetEsignatureDataDetailSource code
  14. GetEsignaturePDFDetailSource code
  15. GetFormsCounterDetailSource code
  16. GetLeasePDFDetailSource code
  17. GetLeaseXMLDataDetailSource code
  18. GetRenewalPDFDetailSource code
  19. GetRenewalXMLDataDetailSource code
  20. GetRestrictedPDFDetailSource code
  21. ListCustomDefaultFieldsDetailSource code
  22. ListCustomFieldsDetailSource code
  23. ListCustomFormsDetailSource code
  24. ListCustomRestrictedFieldsDetailSource code
  25. ListCustomRestrictedFormsDetailSource code
  26. ListDefaultFieldsDetailSource code
  27. ListEsignaturesDetailSource code
  28. ListFieldsDetailSource code
  29. ListFormsDetailSource code
  30. ListPropertiesDetailSource code
  31. ListRenewalDefaultFieldsDetailSource code
  32. ListRenewalFieldsDetailSource code
  33. ListRenewalFormsDetailSource code
  34. ListRestrictedFieldsDetailSource code
  35. ListRestrictedFormsDetailSource code
  36. ListUnitsDetailSource code
  37. ListUserPrivilegesDetailSource code
  38. RenewLeaseDetailSource code
  39. RequestEsignatureDetailSource code
  40. RequestRenewalEsignatureDetailSource code
  41. ResendEsignatureRequestDetailSource code

Operations

    Port type leasePortSource code

    1. AmendRoommates
      Description:
      TAA, NAA, GAA and CAN licenses only - Updates composition of roommates for existing lease record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#AmendRoommates
      Input:
      AmendRoommatesIn (soap:body, use = literal)Source code
      parameters type AmendRoommates
      • SessionId type string
      • LeaseId type int
      • ResidentToMoveOut - nillable; type string
      • ResidentToMoveIn - nillable; type string
      Output:
      AmendRoommatesOut (soap:body, use = literal)Source code
      parameters type AmendRoommatesResponse
      • AmendRoommatesResult type boolean
    2. 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/lease.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
    3. 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/lease.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
    4. CreateLease
      Description:
      Creates new lease record Returns unique LeaseId
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#CreateLease
      Input:
      CreateLeaseIn (soap:body, use = literal)Source code
      parameters type CreateLease
      • SessionId type string
      • LeaseXMLData type string
      • PropertyId - nillable; type int
      • LeaseId - nillable; type int
      Output:
      CreateLeaseOut (soap:body, use = literal)Source code
      parameters type CreateLeaseResponse
      • CreateLeaseResult type int
    5. 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/lease.php#CreateSession
      Input:
      CreateSessionIn (soap:body, use = literal)Source code
      parameters type CreateSession
      • SerialNumber type string
      • UserId type string
      • Password type string
      Output:
      CreateSessionOut (soap:body, use = literal)Source code
      parameters type CreateSessionResponse
      • CreateSessionResult type string
    6. DeleteEsignature
      Description:
      Deletes electronic signature transaction
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#DeleteEsignature
      Input:
      DeleteEsignatureIn (soap:body, use = literal)Source code
      parameters type DeleteEsignature
      • SessionId type string
      • EsignatureId type int
      Output:
      DeleteEsignatureOut (soap:body, use = literal)Source code
      parameters type DeleteEsignatureResponse
      • DeleteEsignatureResult type boolean
    7. DeleteLease
      Description:
      Deletes lease record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#DeleteLease
      Input:
      DeleteLeaseIn (soap:body, use = literal)Source code
      parameters type DeleteLease
      • SessionId type string
      • LeaseId type int
      Output:
      DeleteLeaseOut (soap:body, use = literal)Source code
      parameters type DeleteLeaseResponse
      • DeleteLeaseResult type boolean
    8. EditLease
      Description:
      Modifies an existing lease record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#EditLease
      Input:
      EditLeaseIn (soap:body, use = literal)Source code
      parameters type EditLease
      • SessionId type string
      • LeaseId type int
      • LeaseXMLData type string
      Output:
      EditLeaseOut (soap:body, use = literal)Source code
      parameters type EditLeaseResponse
      • EditLeaseResult type boolean
    9. EditRenewal
      Description:
      TAA and GAA licenses only - Modifies renewal-specific data for an existing lease record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#EditRenewal
      Input:
      EditRenewalIn (soap:body, use = literal)Source code
      parameters type EditRenewal
      • SessionId type string
      • LeaseId type int
      • RenewalXMLData type string
      Output:
      EditRenewalOut (soap:body, use = literal)Source code
      parameters type EditRenewalResponse
      • EditRenewalResult type boolean
    10. ExecuteLease
      Description:
      Apply electronic signature of Owner/Rep to archived lease document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ExecuteLease
      Input:
      ExecuteLeaseIn (soap:body, use = literal)Source code
      parameters type ExecuteLease
      • SessionId type string
      • EsignatureId type int
      • OwnerRepSignature type string
      • OwnerRepInitials - nillable; type string
      Output:
      ExecuteLeaseOut (soap:body, use = literal)Source code
      parameters type ExecuteLeaseResponse
      • ExecuteLeaseResult type boolean
    11. GetDefaultLeaseXMLData
      Description:
      Returns default XML lease data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetDefaultLeaseXMLData
      Input:
      GetDefaultLeaseXMLDataIn (soap:body, use = literal)Source code
      parameters type GetDefaultLeaseXMLData
      • SessionId type string
      • PropertyId - nillable; type int
      Output:
      GetDefaultLeaseXMLDataOut (soap:body, use = literal)Source code
      parameters type GetDefaultLeaseXMLDataResponse
      • GetDefaultLeaseXMLDataResult type string
    12. GetDefaultRenewalXMLData
      Description:
      TAA and GAA licenses only - Returns default XML lease renewal data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetDefaultRenewalXMLData
      Input:
      GetDefaultRenewalXMLDataIn (soap:body, use = literal)Source code
      parameters type GetDefaultRenewalXMLData
      • SessionId type string
      • PropertyId - nillable; type int
      Output:
      GetDefaultRenewalXMLDataOut (soap:body, use = literal)Source code
      parameters type GetDefaultRenewalXMLDataResponse
      • GetDefaultRenewalXMLDataResult type string
    13. GetEsignatureData
      Description:
      Returns electronic signature transaction data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetEsignatureData
      Input:
      GetEsignatureDataIn (soap:body, use = literal)Source code
      parameters type GetEsignatureData
      • SessionId type string
      • EsignatureId type int
      Output:
      GetEsignatureDataOut (soap:body, use = literal)Source code
      parameters type GetEsignatureDataResponse
      • GetEsignatureDataResult type Esignature
        • Id - nillable; type int
        • DateInitiated - nillable; type string
        • DateExecuted - nillable; type string
        • LeaseDate - nillable; type string
        • StreetAddress - nillable; type string
        • UnitNumber - nillable; type string
        • LeaseTermBeginDate - nillable; type string
        • Signers - nillable; type ArrayOfSigner
          • item - optional, unbounded; type Signer
            • Key - nillable; type string
            • Name - nillable; type string
            • Email - nillable; type string
            • DateSigned - nillable; type string
            • PaperlessLeaseRequested - nillable; type boolean
        • LeaseForms - nillable; type ArrayOfFormshort
          • item - optional, unbounded; type FormShort
            • Id - nillable; type string
        • CustomForms - nillable; type ArrayOfFormshort
          • item - optional, unbounded; type FormShort
            • Id - nillable; type string
    14. GetEsignaturePDF
      Description:
      Returns byte stream PDF of lease document archived for electronic signature
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetEsignaturePDF
      Input:
      GetEsignaturePDFIn (soap:body, use = literal)Source code
      parameters type GetEsignaturePDF
      • SessionId type string
      • EsignatureId type int
      • SignerKey - nillable; type string
      Output:
      GetEsignaturePDFOut (soap:body, use = literal)Source code
      parameters type GetEsignaturePDFResponse
      • GetEsignaturePDFResult type base64Binary
    15. 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/lease.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
    16. GetLeasePDF
      Description:
      Returns byte stream PDF of lease document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetLeasePDF
      Input:
      GetLeasePDFIn (soap:body, use = literal)Source code
      parameters type GetLeasePDF
      • SessionId type string
      • LeaseId type int
      • LeaseForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • Preview - nillable; type boolean
      Output:
      GetLeasePDFOut (soap:body, use = literal)Source code
      parameters type GetLeasePDFResponse
      • GetLeasePDFResult type base64Binary
    17. GetLeaseXMLData
      Description:
      Returns XML lease data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetLeaseXMLData
      Input:
      GetLeaseXMLDataIn (soap:body, use = literal)Source code
      parameters type GetLeaseXMLData
      • SessionId type string
      • LeaseId type int
      Output:
      GetLeaseXMLDataOut (soap:body, use = literal)Source code
      parameters type GetLeaseXMLDataResponse
      • GetLeaseXMLDataResult type string
    18. GetRenewalPDF
      Description:
      TAA and GAA licenses only - Returns byte stream PDF of lease renewal document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetRenewalPDF
      Input:
      GetRenewalPDFIn (soap:body, use = literal)Source code
      parameters type GetRenewalPDF
      • SessionId type string
      • LeaseId type int
      • RenewalForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • Preview - nillable; type boolean
      Output:
      GetRenewalPDFOut (soap:body, use = literal)Source code
      parameters type GetRenewalPDFResponse
      • GetRenewalPDFResult type base64Binary
    19. GetRenewalXMLData
      Description:
      TAA and GAA licenses only - Returns XML lease renewal data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetRenewalXMLData
      Input:
      GetRenewalXMLDataIn (soap:body, use = literal)Source code
      parameters type GetRenewalXMLData
      • SessionId type string
      • LeaseId type int
      Output:
      GetRenewalXMLDataOut (soap:body, use = literal)Source code
      parameters type GetRenewalXMLDataResponse
      • GetRenewalXMLDataResult type string
    20. GetRestrictedPDF
      Description:
      Returns byte stream PDF of non-batch-printable form
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#GetRestrictedPDF
      Input:
      GetRestrictedPDFIn (soap:body, use = literal)Source code
      parameters type GetRestrictedPDF
      • SessionId type string
      • LeaseId type int
      • StandardForm - nillable; type FormShort
        • Id - nillable; type string
      • CustomForm - nillable; 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
    21. ListCustomDefaultFields
      Description:
      Returns info for custom fields available in Default Lease template for current license
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListCustomDefaultFields
      Input:
      ListCustomDefaultFieldsIn (soap:body, use = literal)Source code
      parameters type ListCustomDefaultFields
      • SessionId type string
      Output:
      ListCustomDefaultFieldsOut (soap:body, use = literal)Source code
      parameters type ListCustomDefaultFieldsResponse
      • ListCustomDefaultFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    22. ListCustomFields
      Description:
      Returns info for custom fields available in Lease Database for current license
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListCustomFields
      Input:
      ListCustomFieldsIn (soap:body, use = literal)Source code
      parameters type ListCustomFields
      • SessionId type string
      • PropertyId - nillable; type int
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      Output:
      ListCustomFieldsOut (soap:body, use = literal)Source code
      parameters type ListCustomFieldsResponse
      • ListCustomFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    23. ListCustomForms
      Description:
      Returns info for custom lease 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/lease.php#ListCustomForms
      Input:
      ListCustomFormsIn (soap:body, use = literal)Source code
      parameters type ListCustomForms
      • SessionId type string
      • PropertyId - nillable; type int
      • ExcludeEsignatureRestrictedForms - nillable; type boolean
      Output:
      ListCustomFormsOut (soap:body, use = literal)Source code
      parameters type ListCustomFormsResponse
      • ListCustomFormsResult 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
    24. ListCustomRestrictedFields
      Description:
      Returns info for fields available on non-batch-printable custom 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/lease.php#ListCustomRestrictedFields
      Input:
      ListCustomRestrictedFieldsIn (soap:body, use = literal)Source code
      parameters type ListCustomRestrictedFields
      • SessionId type string
      • Form type FormShort
        • Id - nillable; type string
      • PropertyId - nillable; type int
      Output:
      ListCustomRestrictedFieldsOut (soap:body, use = literal)Source code
      parameters type ListCustomRestrictedFieldsResponse
      • ListCustomRestrictedFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    25. ListCustomRestrictedForms
      Description:
      Returns info for custom non-batch-printable 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/lease.php#ListCustomRestrictedForms
      Input:
      ListCustomRestrictedFormsIn (soap:body, use = literal)Source code
      parameters type ListCustomRestrictedForms
      • SessionId type string
      • PropertyId - nillable; type int
      Output:
      ListCustomRestrictedFormsOut (soap:body, use = literal)Source code
      parameters type ListCustomRestrictedFormsResponse
      • ListCustomRestrictedFormsResult 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
    26. ListDefaultFields
      Description:
      Returns info for fields available in Lease database 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/lease.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
    27. ListEsignatures
      Description:
      Returns info for all electronic signature transactions matching specified criteria
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListEsignatures
      Input:
      ListEsignaturesIn (soap:body, use = literal)Source code
      parameters type ListEsignatures
      • SessionId type string
      • PropertyId - nillable; type int
      • IncludeNonpending - nillable; type boolean
      • UnitNumber - nillable; type string
      • StreetAddress - nillable; type string
      • ResidentName - nillable; type string
      • StartDate - nillable; type string
      • EndDate - nillable; type string
      Output:
      ListEsignaturesOut (soap:body, use = literal)Source code
      parameters type ListEsignaturesResponse
      • ListEsignaturesResult type ArrayOfEsignature
        • item - optional, unbounded; type Esignature
          • Id - nillable; type int
          • DateInitiated - nillable; type string
          • DateExecuted - nillable; type string
          • LeaseDate - nillable; type string
          • StreetAddress - nillable; type string
          • UnitNumber - nillable; type string
          • LeaseTermBeginDate - nillable; type string
          • Signers - nillable; type ArrayOfSigner
            • item - optional, unbounded; type Signer
              • Key - nillable; type string
              • Name - nillable; type string
              • Email - nillable; type string
              • DateSigned - nillable; type string
              • PaperlessLeaseRequested - nillable; type boolean
          • LeaseForms - nillable; type ArrayOfFormshort
            • item - optional, unbounded; type FormShort
              • Id - nillable; type string
          • CustomForms - nillable; type ArrayOfFormshort
            • item - optional, unbounded; type FormShort
              • Id - nillable; type string
    28. ListFields
      Description:
      Returns info for fields available in Lease database for current license
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListFields
      Input:
      ListFieldsIn (soap:body, use = literal)Source code
      parameters type ListFields
      • SessionId type string
      • PropertyId - nillable; type int
      • StandardForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      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
    29. ListForms
      Description:
      Returns info for lease 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/lease.php#ListForms
      Input:
      ListFormsIn (soap:body, use = literal)Source code
      parameters type ListForms
      • SessionId type string
      • PropertyId - nillable; type int
      • LeaseId - nillable; type int
      • ExcludeEsignatureRestrictedForms - nillable; type boolean
      Output:
      ListFormsOut (soap:body, use = literal)Source code
      parameters type ListFormsResponse
      • ListFormsResult 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
    30. 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/lease.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
    31. ListRenewalDefaultFields
      Description:
      TAA and GAA licenses only - Returns info for renewal-specific fields available in Lease database 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/lease.php#ListRenewalDefaultFields
      Input:
      ListRenewalDefaultFieldsIn (soap:body, use = literal)Source code
      parameters type ListRenewalDefaultFields
      • SessionId type string
      • PropertyId - nillable; type int
      Output:
      ListRenewalDefaultFieldsOut (soap:body, use = literal)Source code
      parameters type ListRenewalDefaultFieldsResponse
      • ListRenewalDefaultFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    32. ListRenewalFields
      Description:
      TAA and GAA licenses only - Returns info for renewal-specific fields available in Lease database for current license
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListRenewalFields
      Input:
      ListRenewalFieldsIn (soap:body, use = literal)Source code
      parameters type ListRenewalFields
      • SessionId type string
      • PropertyId - nillable; type int
      • StandardForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      Output:
      ListRenewalFieldsOut (soap:body, use = literal)Source code
      parameters type ListRenewalFieldsResponse
      • ListRenewalFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    33. ListRenewalForms
      Description:
      TAA and GAA licenses only - Returns info for lease renewal 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/lease.php#ListRenewalForms
      Input:
      ListRenewalFormsIn (soap:body, use = literal)Source code
      parameters type ListRenewalForms
      • SessionId type string
      • PropertyId - nillable; type int
      • ExcludeEsignatureRestrictedForms - nillable; type boolean
      Output:
      ListRenewalFormsOut (soap:body, use = literal)Source code
      parameters type ListRenewalFormsResponse
      • ListRenewalFormsResult 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
    34. ListRestrictedFields
      Description:
      Returns info for fields available on non-batch-printable 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/lease.php#ListRestrictedFields
      Input:
      ListRestrictedFieldsIn (soap:body, use = literal)Source code
      parameters type ListRestrictedFields
      • SessionId type string
      • Form type FormShort
        • Id - nillable; type string
      • PropertyId - nillable; type int
      Output:
      ListRestrictedFieldsOut (soap:body, use = literal)Source code
      parameters type ListRestrictedFieldsResponse
      • ListRestrictedFieldsResult type ArrayOfField
        • item - optional, unbounded; type Field
          • Name - nillable; type string
          • Type - nillable; type string
          • Length - nillable; type string
          • Required - nillable; type boolean
    35. ListRestrictedForms
      Description:
      Returns info for non-batch-printable 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/lease.php#ListRestrictedForms
      Input:
      ListRestrictedFormsIn (soap:body, use = literal)Source code
      parameters type ListRestrictedForms
      • SessionId type string
      • PropertyId - nillable; type int
      Output:
      ListRestrictedFormsOut (soap:body, use = literal)Source code
      parameters type ListRestrictedFormsResponse
      • ListRestrictedFormsResult 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
    36. ListUnits
      Description:
      Returns info for all lease records matching specified criteria
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ListUnits
      Input:
      ListUnitsIn (soap:body, use = literal)Source code
      parameters type ListUnits
      • SessionId type string
      • PropertyId - nillable; type int
      • UnitNumber - nillable; type string
      • StreetAddress - nillable; type string
      • ResidentName - nillable; type string
      • StartDate - nillable; type string
      • EndDate - nillable; type string
      Output:
      ListUnitsOut (soap:body, use = literal)Source code
      parameters type ListUnitsResponse
      • ListUnitsResult type ArrayOfUnit
        • item - optional, unbounded; type Unit
          • Id - nillable; type int
          • LeaseDate - nillable; type string
          • StreetAddress - nillable; type string
          • UnitNumber - nillable; type string
          • LeaseTermBeginDate - nillable; type string
          • LeaseTermEndDate - nillable; type string
          • Residents - nillable; type ArrayOfResident
            • item - optional, unbounded; type Resident
              • Number - nillable; type int
              • Name - nillable; type string
          • Renewed - nillable; type boolean
    37. 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/lease.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
    38. RenewLease
      Description:
      TAA and GAA licenses only - Extends term of existing lease record
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#RenewLease
      Input:
      RenewLeaseIn (soap:body, use = literal)Source code
      parameters type RenewLease
      • SessionId type string
      • LeaseId type int
      • RenewalXMLData type string
      • ImportDefaultLeaseData - nillable; type boolean
      Output:
      RenewLeaseOut (soap:body, use = literal)Source code
      parameters type RenewLeaseResponse
      • RenewLeaseResult type boolean
    39. RequestEsignature
      Description:
      Generates/archives PDF lease document and sends electronic signature request to all lease signers Returns unique EsignatureId
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#RequestEsignature
      Input:
      RequestEsignatureIn (soap:body, use = literal)Source code
      parameters type RequestEsignature
      • SessionId type string
      • LeaseId type int
      • OwnerRep type Contact
        • Name - nillable; type string
        • Email - nillable; type string
        • Phone - nillable; type string
      • Residents type ArrayOfContact
        • item - optional, unbounded; type Contact
          • Name - nillable; type string
          • Email - nillable; type string
          • Phone - nillable; type string
      • LeaseForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • SendOwnerRepNotices - nillable; type boolean
      Output:
      RequestEsignatureOut (soap:body, use = literal)Source code
      parameters type RequestEsignatureResponse
      • RequestEsignatureResult type int
    40. RequestRenewalEsignature
      Description:
      TAA and GAA licenses only - Generates/archives PDF lease renewal document and sends electronic signature request to all lease signers Returns unique EsignatureId
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#RequestRenewalEsignature
      Input:
      RequestRenewalEsignatureIn (soap:body, use = literal)Source code
      parameters type RequestRenewalEsignature
      • SessionId type string
      • LeaseId type int
      • OwnerRep type Contact
        • Name - nillable; type string
        • Email - nillable; type string
        • Phone - nillable; type string
      • Residents type ArrayOfContact
        • item - optional, unbounded; type Contact
          • Name - nillable; type string
          • Email - nillable; type string
          • Phone - nillable; type string
      • RenewalForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • CustomForms - nillable; type ArrayOfFormshort
        • item - optional, unbounded; type FormShort
          • Id - nillable; type string
      • SendOwnerRepNotices - nillable; type boolean
      Output:
      RequestRenewalEsignatureOut (soap:body, use = literal)Source code
      parameters type RequestRenewalEsignatureResponse
      • RequestRenewalEsignatureResult type int
    41. ResendEsignatureRequest
      Description:
      Resend electronic signature notification email to resident
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://www.bluemoonforms.com/services/lease.php#ResendEsignatureRequest
      Input:
      ResendEsignatureRequestIn (soap:body, use = literal)Source code
      parameters type ResendEsignatureRequest
      • SessionId type string
      • SignerKey type string
      • Email - nillable; type string
      Output:
      ResendEsignatureRequestOut (soap:body, use = literal)Source code
      parameters type ResendEsignatureRequestResponse
      • ResendEsignatureRequestResult type boolean

WSDL source code

<?xml version="1.0"?>
<definitions name="lease" targetNamespace="https://www.bluemoonforms.com/services/lease.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/lease.php"
xmlns="http://schemas.xmlsoap.org/wsdl/"
>
<types>
<xsd:schema targetNamespace="https://www.bluemoonforms.com/services/lease.php"></xsd:schema>
</types>
<portType name="leasePort">
<operation name="AmendRoommates">
<documentation>TAA, NAA, GAA and CAN licenses only - Updates composition of roommates for existing lease record</documentation>
</operation>
<operation name="EditRenewal">
<documentation>TAA and GAA licenses only - Modifies renewal-specific data for an existing lease record</documentation>
</operation>
<operation name="ExecuteLease">
<documentation>Apply electronic signature of Owner/Rep to archived lease document</documentation>
</operation>
<operation name="GetEsignaturePDF">
<documentation>Returns byte stream PDF of lease document archived for electronic signature</documentation>
</operation>
<operation name="GetRenewalPDF">
<documentation>TAA and GAA licenses only - Returns byte stream PDF of lease renewal document</documentation>
</operation>
<operation name="ListCustomDefaultFields">
<documentation>Returns info for custom fields available in Default Lease template for current license</documentation>
</operation>
<operation name="ListCustomFields">
<documentation>Returns info for custom fields available in Lease Database for current license</documentation>
</operation>
<operation name="ListCustomForms">
<documentation>Returns info for custom lease forms available for current license</documentation>
</operation>
<operation name="ListCustomRestrictedFields">
<documentation>Returns info for fields available on non-batch-printable custom form for current license</documentation>
</operation>
<operation name="ListDefaultFields">
<documentation>Returns info for fields available in Lease database for current license which can auto-populate from Default Lease template</documentation>
</operation>
<operation name="ListEsignatures">
<documentation>Returns info for all electronic signature transactions matching specified criteria</documentation>
</operation>
<operation name="ListFields">
<documentation>Returns info for fields available in Lease database for current license</documentation>
</operation>
<operation name="ListForms">
<documentation>Returns info for lease forms available for current license</documentation>
</operation>
<operation name="ListRenewalDefaultFields">
<documentation>TAA and GAA licenses only - Returns info for renewal-specific fields available in Lease database for current license which can auto-populate from Default Lease template</documentation>
</operation>
<operation name="ListRenewalFields">
<documentation>TAA and GAA licenses only - Returns info for renewal-specific fields available in Lease database for current license</documentation>
</operation>
<operation name="ListRenewalForms">
<documentation>TAA and GAA licenses only - Returns info for lease renewal forms available for current license</documentation>
</operation>
<operation name="ListRestrictedFields">
<documentation>Returns info for fields available on non-batch-printable form for current license</documentation>
</operation>
<operation name="ListRestrictedForms">
<documentation>Returns info for non-batch-printable forms available for current license</documentation>
</operation>
<operation name="ListUnits">
<documentation>Returns info for all lease records matching specified criteria</documentation>
</operation>
<operation name="RenewLease">
<documentation>TAA and GAA licenses only - Extends term of existing lease record</documentation>
</operation>
<operation name="RequestEsignature">
<documentation>Generates/archives PDF lease document and sends electronic signature request to all lease signers Returns unique EsignatureId</documentation>
</operation>
<operation name="RequestRenewalEsignature">
<documentation>TAA and GAA licenses only - Generates/archives PDF lease renewal document and sends electronic signature request to all lease signers Returns unique EsignatureId</documentation>
</operation>
<operation name="ListProperties">
<documentation>Returns info for all properties contained by current license</documentation>
</operation>
</portType>
<binding name="leaseBinding" type="tns:leasePort"></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