WS_MobileAPI Web Service

WS_MobileAPI

Click here for a complete list of operations.

FetchRegistrationRequest

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /mobilesrv/WS_MobileAPI.asmx HTTP/1.1
Host: hqiemobileuat.com.qa
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/FetchRegistrationRequest"

<?xml version="1.0" encoding="utf-8"?>
<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>
    <FetchRegistrationRequest xmlns="http://tempuri.org/">
      <fetchRegistrationRequest>
        <signature>string</signature>
        <serviceName>string</serviceName>
        <dateStamp>string</dateStamp>
        <CompanyCode>string</CompanyCode>
        <DeviceID>string</DeviceID>
      </fetchRegistrationRequest>
    </FetchRegistrationRequest>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<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>
    <FetchRegistrationRequestResponse xmlns="http://tempuri.org/">
      <FetchRegistrationRequestResult>
        <latestDataFetchTime>string</latestDataFetchTime>
        <ApiResponse>
          <StatusCode>int</StatusCode>
          <Message>string</Message>
          <Details>string</Details>
          <TimeStamp>string</TimeStamp>
        </ApiResponse>
        <Nationality>
          <Nationality>
            <CODE>string</CODE>
            <COUNME>string</COUNME>
            <STATUS>string</STATUS>
            <FLAG>string</FLAG>
          </Nationality>
          <Nationality>
            <CODE>string</CODE>
            <COUNME>string</COUNME>
            <STATUS>string</STATUS>
            <FLAG>string</FLAG>
          </Nationality>
        </Nationality>
        <IDType>
          <IDType>
            <CODE>string</CODE>
            <IDNAME>string</IDNAME>
          </IDType>
          <IDType>
            <CODE>string</CODE>
            <IDNAME>string</IDNAME>
          </IDType>
        </IDType>
        <SOI>
          <SOIList>
            <SOICode>string</SOICode>
            <SOIName>string</SOIName>
            <Status>string</Status>
          </SOIList>
          <SOIList>
            <SOICode>string</SOICode>
            <SOIName>string</SOIName>
            <Status>string</Status>
          </SOIList>
        </SOI>
        <Profession>
          <ProfessionList>
            <ProfCode>string</ProfCode>
            <ProfName>string</ProfName>
          </ProfessionList>
          <ProfessionList>
            <ProfCode>string</ProfCode>
            <ProfName>string</ProfName>
          </ProfessionList>
        </Profession>
        <AnnualIncome>
          <AnnualIncomeList>
            <IncomeCode>string</IncomeCode>
            <IncomeName>string</IncomeName>
          </AnnualIncomeList>
          <AnnualIncomeList>
            <IncomeCode>string</IncomeCode>
            <IncomeName>string</IncomeName>
          </AnnualIncomeList>
        </AnnualIncome>
        <Sponsor>
          <SponsorList>
            <SponsorCode>string</SponsorCode>
            <SponsorName>string</SponsorName>
          </SponsorList>
          <SponsorList>
            <SponsorCode>string</SponsorCode>
            <SponsorName>string</SponsorName>
          </SponsorList>
        </Sponsor>
        <SubSponsor>
          <SubSponsorList>
            <SubSponsorCode>string</SubSponsorCode>
            <SubSponsorName>string</SubSponsorName>
          </SubSponsorList>
          <SubSponsorList>
            <SubSponsorCode>string</SubSponsorCode>
            <SubSponsorName>string</SubSponsorName>
          </SubSponsorList>
        </SubSponsor>
        <CountryOfIssue>
          <CountryOfIssueList>
            <CountryIssueCode>string</CountryIssueCode>
            <CountryIssueName>string</CountryIssueName>
          </CountryOfIssueList>
          <CountryOfIssueList>
            <CountryIssueCode>string</CountryIssueCode>
            <CountryIssueName>string</CountryIssueName>
          </CountryOfIssueList>
        </CountryOfIssue>
        <Purpose>
          <POT>
            <CODE>string</CODE>
            <POTNME>string</POTNME>
            <STATUS>string</STATUS>
          </POT>
          <POT>
            <CODE>string</CODE>
            <POTNME>string</POTNME>
            <STATUS>string</STATUS>
          </POT>
        </Purpose>
        <Relation>
          <RELATION>
            <relcode>string</relcode>
            <relname>string</relname>
          </RELATION>
          <RELATION>
            <relcode>string</relcode>
            <relname>string</relname>
          </RELATION>
        </Relation>
        <Language>
          <Lang>
            <CODE>string</CODE>
            <LANG>string</LANG>
          </Lang>
          <Lang>
            <CODE>string</CODE>
            <LANG>string</LANG>
          </Lang>
        </Language>
      </FetchRegistrationRequestResult>
    </FetchRegistrationRequestResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /mobilesrv/WS_MobileAPI.asmx HTTP/1.1
Host: hqiemobileuat.com.qa
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FetchRegistrationRequest xmlns="http://tempuri.org/">
      <fetchRegistrationRequest>
        <signature>string</signature>
        <serviceName>string</serviceName>
        <dateStamp>string</dateStamp>
        <CompanyCode>string</CompanyCode>
        <DeviceID>string</DeviceID>
      </fetchRegistrationRequest>
    </FetchRegistrationRequest>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FetchRegistrationRequestResponse xmlns="http://tempuri.org/">
      <FetchRegistrationRequestResult>
        <latestDataFetchTime>string</latestDataFetchTime>
        <ApiResponse>
          <StatusCode>int</StatusCode>
          <Message>string</Message>
          <Details>string</Details>
          <TimeStamp>string</TimeStamp>
        </ApiResponse>
        <Nationality>
          <Nationality>
            <CODE>string</CODE>
            <COUNME>string</COUNME>
            <STATUS>string</STATUS>
            <FLAG>string</FLAG>
          </Nationality>
          <Nationality>
            <CODE>string</CODE>
            <COUNME>string</COUNME>
            <STATUS>string</STATUS>
            <FLAG>string</FLAG>
          </Nationality>
        </Nationality>
        <IDType>
          <IDType>
            <CODE>string</CODE>
            <IDNAME>string</IDNAME>
          </IDType>
          <IDType>
            <CODE>string</CODE>
            <IDNAME>string</IDNAME>
          </IDType>
        </IDType>
        <SOI>
          <SOIList>
            <SOICode>string</SOICode>
            <SOIName>string</SOIName>
            <Status>string</Status>
          </SOIList>
          <SOIList>
            <SOICode>string</SOICode>
            <SOIName>string</SOIName>
            <Status>string</Status>
          </SOIList>
        </SOI>
        <Profession>
          <ProfessionList>
            <ProfCode>string</ProfCode>
            <ProfName>string</ProfName>
          </ProfessionList>
          <ProfessionList>
            <ProfCode>string</ProfCode>
            <ProfName>string</ProfName>
          </ProfessionList>
        </Profession>
        <AnnualIncome>
          <AnnualIncomeList>
            <IncomeCode>string</IncomeCode>
            <IncomeName>string</IncomeName>
          </AnnualIncomeList>
          <AnnualIncomeList>
            <IncomeCode>string</IncomeCode>
            <IncomeName>string</IncomeName>
          </AnnualIncomeList>
        </AnnualIncome>
        <Sponsor>
          <SponsorList>
            <SponsorCode>string</SponsorCode>
            <SponsorName>string</SponsorName>
          </SponsorList>
          <SponsorList>
            <SponsorCode>string</SponsorCode>
            <SponsorName>string</SponsorName>
          </SponsorList>
        </Sponsor>
        <SubSponsor>
          <SubSponsorList>
            <SubSponsorCode>string</SubSponsorCode>
            <SubSponsorName>string</SubSponsorName>
          </SubSponsorList>
          <SubSponsorList>
            <SubSponsorCode>string</SubSponsorCode>
            <SubSponsorName>string</SubSponsorName>
          </SubSponsorList>
        </SubSponsor>
        <CountryOfIssue>
          <CountryOfIssueList>
            <CountryIssueCode>string</CountryIssueCode>
            <CountryIssueName>string</CountryIssueName>
          </CountryOfIssueList>
          <CountryOfIssueList>
            <CountryIssueCode>string</CountryIssueCode>
            <CountryIssueName>string</CountryIssueName>
          </CountryOfIssueList>
        </CountryOfIssue>
        <Purpose>
          <POT>
            <CODE>string</CODE>
            <POTNME>string</POTNME>
            <STATUS>string</STATUS>
          </POT>
          <POT>
            <CODE>string</CODE>
            <POTNME>string</POTNME>
            <STATUS>string</STATUS>
          </POT>
        </Purpose>
        <Relation>
          <RELATION>
            <relcode>string</relcode>
            <relname>string</relname>
          </RELATION>
          <RELATION>
            <relcode>string</relcode>
            <relname>string</relname>
          </RELATION>
        </Relation>
        <Language>
          <Lang>
            <CODE>string</CODE>
            <LANG>string</LANG>
          </Lang>
          <Lang>
            <CODE>string</CODE>
            <LANG>string</LANG>
          </Lang>
        </Language>
      </FetchRegistrationRequestResult>
    </FetchRegistrationRequestResponse>
  </soap12:Body>
</soap12:Envelope>