WE'RE HERE TO HELP!

Updated Custom Form API Calls

Last Updated:
byEljie Lagunay
Views131

 LeadMaster API

1. workgroup custom form list

Description : This web service will list custom form associated to the workgroup.

URL: api.leadmaster.com/LMService/LMService.asmx?op=GetCustomFormList
Method 1: LMGetCustomFormList(string api_key, int company_id)
Method 2: GetCustomFormList(int logon_id, string pwd, int company_id)
 
POST /lmservice/lmservice.asmx HTTP/1.1
Host: api.leadmaster.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/GetCustomformList"
Request :
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
    </CustomFormList>
  </soap:Body>
 
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomformResponse xmlns="LMServiceNamespace">
      <CustomformResult>
        <TypeCustomFormList>
          <FormID>int</ FormID >
          <FormName>string</FormName>
          <FormType>string</ FormType >
        </ TypeCustomFormList >
        < TypeCustomFormList >
          <FormID>int</ FormID >
          <FormName>string</FormName>
          <FormType>string</ FormType >
        </ TypeCustomFormList >
      </CustomformResult>
    </CustomformResponse>
  </soap:Body>
</soap:Envelope>

2. get custom form schema with questions and type

Description : This web service will  return custom form questions with attributes.

URL: api.leadmaster.com/LMService/LMService.asmx?op=LMGetCustomForm
Method 1: LMGetCustomForm(string api_key, int company_id, int FormID)
Method 2: GetCustomForm(int logon_id, string pwdint company_id, int FormID)
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/GetCustomFormStructure"


Request :
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
              <FormID>int</ FormID >
    </CustomFormList>
  </soap:Body>
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomformResponse xmlns="LMServiceNamespace">
      <CustomformResult>
        <TypeCustomFormSchema>
          <Questionid>int</ Questionid >
          <QuestionType>string</ QuestionType >
          <Que>string</ QuestionType >
           <QRequire>boolean</QRequire>
          <QSize>string</QSize>
                 .    
               .     
                .     
        </TypeCustomFormSchema>
        <TypeCustomFormSchema>
          <Questionid>int</ Questionid >
          <QuestionType>string</ QuestionType >
          <Que>string</ QuestionType >
           <QRequire>boolean</QRequire>
          <QSize>string</QSize>
                 .    
               .     
                .     
        </TypeCustomFormSchema>
      </CustomformResult>
    </CustomformResponse>
  </soap:Body>
</soap:Envelope>

3. List custom form attached to the record

Description : This web service will list custom form attached to the record.

RL: api.leadmaster.com/LMService/LMService.asmx?op= LMGetCustomFormListRecord
Method 1: LMGetCustomFormListRecord(string api_key, int company_id, int RECDNO)
Method 2: GetCustomFormListRecord(int logon_id, string pwd, int company_id, int RECDNO)
POST /lmservice/lmservice.asmx HTTP/1.1
Host: api.leadmaster.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/GetCustomFormonRecord"

Request :
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
              <recdno>int</ recdno >
    </CustomFormList>
  </soap:Body>
 
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomformResponse xmlns="LMServiceNamespace">
      <CustomformResult>
        <TypeCustomForm>
          <RECDNO>int</RECDNO>
          <ChildRecordID>int</ ChildRecordID >
          <FormID>int</ FormID >
          <FormName>string</FormName>
        </ TypeCustomForm >
        <TypeCustomForm >
          <RECDNO>int</RECDNO>
          <ChildRecordID>int</ ChildRecordID >
          <FormID>int</ FormID >
          <FormName>string</FormName>
        </ TypeCustomForm >
      </CustomformResult>
    </CustomformResponse>
  </soap:Body>
</soap:Envelope>

4. Attach custom form to the record

Description : This web service will attached custom form to the record.

URL: api.leadmaster.com/LMService/LMService.asmx?op= LMAttachCustomFormRecord
Method 1: LMAttachCustomFormRecord(string api_key, int company_id, int RECDNO, int FormID)
Method 2: AttachCustomFormRecord(int logon_id, string pwd, int company_id, int RECDNO, int FormID)
 
POST /lmservice/lmservice.asmx HTTP/1.1
Host: api.leadmaster.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/AttachCustomForm"


Request :
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
              <recdno>int</recdno >
              <FormID>int</FormID >
    </CustomFormList>
  </soap:Body>
 
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomformResponse xmlns="LMServiceNamespace">
      <CustomformResult>
          <ChildRecordID>int</ ChildRecordID >
      </CustomformResult>
    </CustomformResponse>
  </soap:Body>
</soap:Envelope>
 

5. Submit custom form

Description : This web service will update custom form attached to record.

URL: api.leadmaster.com/LMService/LMService.asmx?op= LMUpdateCustomFormRecord
Method 1: LMUpdateCustomFormRecord(string api_key, int company_id, int RECDNO, int FormID, int ChildRecordID, Customformtype.TypeCustomFormData[] CustomFormData)
Method 2: UpdateCustomFormRecord(int logon_id, string pwd, int company_id, int RECDNO, int FormID, int ChildRecordID, Customformtype.TypeCustomFormData[] CustomFormData)
 
POST /lmservice/lmservice.asmx HTTP/1.1
Host: api.leadmaster.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/SubmitCustomForm"

Request :
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
              <recdno>int</ recdno >
               <FormID>int</FormID>
              <childrecordid>int</ childrecordid >
              <TypeCustomFormData>
                  <QuestionID>int</ QuestionID >
                  <value>string<value>
              </TypeCustomFormData >
              <TypeCustomFormData>
                  <QuestionID>int</ QuestionID >
                  <value>string<value>
              </TypeCustomFormData >
              <TypeCustomFormData>
                  <QuestionID>int</ QuestionID >
                  <value>string<value>
              </TypeCustomFormData >
    </CustomFormList>
  </soap:Body>
 
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomformResponse xmlns="LMServiceNamespace">
      <CustomformResult>
        <TypeCustomForm>
          <result>boolean</result>
        </ TypeCustomForm >
      </CustomformResult>
    </CustomformResponse>
  </soap:Body>
</soap:Envelope>

 
 

6. Get  custom form Data

Description : This web service will return custom form result attached to the record.

URL: api.leadmaster.com/LMService/LMService.asmx?op=LMGetCustomFormRecord
Method 1: LMGetCustomFormRecord(string api_key, int company_id, int RECDNO, int FormID, int ChildRecordID)
Method 2: GetCustomFormRecord(int logon_id, string pwd, int company_id, int RECDNO, int FormID, int ChildRecordID)
 
POST /lmservice/lmservice.asmx HTTP/1.1
Host: api.leadmaster.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LMServiceNamespace/GetCustomFormData"

Request :
       
  <soap:Body>
    <CustomFormList xmlns="LMServiceNamespace">
              <logon_id>int</logon_id>
              <pwd>string</pwd>
              <company_id>int</company_id>
              <recdno>int</ recdno >
              <FormID>int</ FormID >
              <childrecordid>int</ childrecordid >
    </CustomFormList>
  </soap:Body>
 
Response :

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
     <CustomformResult>
        <TypeCustomForm>
          <QuestionID>int</ QuestionID >
           <value>string<value>
        </ TypeCustomForm >
        <TypeCustomForm >
           <QuestionID>int</ QuestionID >
           <value>string<value>
        </ TypeCustomForm >
      </CustomformResult>
  </soap:Body>
</soap:Envelope>
Was this article helpful?
How can we improve this article?

Leave a Reply

Your email address will not be published. Required fields are marked *

Share This

Share on facebook
Share on twitter
Share on linkedin
Share on skype
Share on email
Share on print

Need More Help?

Can't find what you're looking for?
Email Us

WHAT'S NEW IN APP4

In This Article
Scroll to Top