Contacts.asmx

CreateContactEntry

Create Rolodex Contact Entry.

public string CreateContactEntry(string authorizationTicket, string xmlDoc)

Parameters

authorizationTicket - Authentication string returned by AuthService.asmx.

xmlDoc - XML document containing new contact information

Return Value

XML Result - The result indicating the success of the operation or a list of errors

The XML result has following format for a successful result:

<result status="OK"/>

The XML result has the following format for an unsuccessful result:

<result status="Error">
<error>Missing required fields: Name, Addr, City</error>
<error>Invalid XML Document</error>
...
</result>

Remark

authorizationTicket must contain authentication of ML-M non-TPO user with permission to read/write contacts.

Example

Sample Request

UpdateContactEntry

Update Rolodex Contact Entry.

public string UpdateContactEntry(string authorizationTicket, string xmlDoc, string filterQuery)

Parameters

authorizationTicket - Authentication string returned by AuthService.asmx.

xmlDoc - XML document containing new contact information

filterQuery - XML document containing parameters to locate contact entry. Name, Type, AgentIsApproved, AgentLicenseNumber, CompanyName, CompanyID, CompanyLicenseNumber are supported.

Return Value

XML Result - The result indicating the success of the operation or a list of errors

The XML result has following format for a successful result:

<result status="OK"/>

The XML result has the following format for an unsuccessful result:

<result status="Error">
<error>Missing required fields: Name, Addr, City</error>
<error>Invalid XML Document</error>
...
</result>

Remark

authorizationTicket must contain authentication of ML-M non-TPO user with permission to read/write contacts.

Example

Sample Request
Sample filterQuery

DeleteContactEntry

Delete Rolodex Contact Entry.

public string DeleteContactEntry(string authorizationTicket, string filterQuery)

Parameters

authorizationTicket - Authentication string returned by AuthService.asmx.

filterQuery - XML document containing parameters to locate contact entry. Name, Type, AgentIsApproved, AgentLicenseNumber, CompanyName, CompanyID, CompanyLicenseNumber are supported.

Return Value

XML Result - The result indicating the success of the operation or a list of errors

The XML result has following format for a successful result:

<result status="OK"/>

The XML result has the following format for an unsuccessful result:

<result status="Error">
<error>Cannot locate Contact Entry.</error>
...
</result>

Remark

authorizationTicket must contain authentication of ML-M non-TPO user with permission to read/write contacts.

Example

Sample filterQuery

SearchContactEntry

Find Contact Entries.

public string SearchContactEntry(string authorizationTicket, string filterQuery)

Parameters

authorizationTicket - Authentication string returned by AuthService.asmx.

filterQuery - XML document containing parameters to locate contact entry. Name, Type, AgentIsApproved, AgentLicenseNumber, CompanyName, CompanyID, CompanyLicenseNumber are supported.

Return Value

XML collection of Contact Entries

<Contacts>
<Contact>
<Type>Appraiser</Type>
<TypeDescription>Appraiser</TypeDescription>
<Name>Contact Entry Name</Name>
...
</Contact>
</Contacts>

Remark

authorizationTicket must contain authentication of ML-M non-TPO user with permission to read contacts.

Example

Sample filterQuery

ExportInvestorContactsAsCSV

Exports the Investor Contacts as a CSV

public string ExportInvestorContactsAsCSV(string authorizationTicket)

Parameters

authorizationTicket - Authentication string returned by AuthService.asmx.

Return Value

Xml result containing the investor contacts CSV if successful.

The below XML result has the following format for a successful result:

<LOXmlFormat>
<result status="OK">
<InvestorContactsCsv>...</InvestorContactsCsv>
</result>
</LOXmlFormat>

XML result containing errors if unsuccessful.

The XML result has the following format for an unsuccessful result:

<LOXmlFormat>
<result status="Error">
<Errors>
<Error>Unable to export.</Error>
...
</Errors>
</result>
</LOXmlFormat>