PersonWS Web Service

PersonWS

Click here for a complete list of operations.

GetPerson

Gets data about one person. Search can be made by using the official id.

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 /PasLinkWS/PersonWS/PersonWS.asmx HTTP/1.1
Host: linkws.service.tieto.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/GetPerson"

<?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:Header>
    <RequestHeader xmlns="http://healthXML.org/PasLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap:Header>
  <soap:Body>
    <GetPerson xmlns="http://healthXML.org/PasLink">
      <OfficialId>string</OfficialId>
      <TypeOfId>string</TypeOfId>
    </GetPerson>
  </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:Header>
    <ResponseHeader xmlns="http://healthXML.org/PasLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <ErrorInformation>
        <FunctionName>string</FunctionName>
        <Severity>None or Critical or Warning or Information</Severity>
        <ErrorType>string</ErrorType>
        <ModuleName>string</ModuleName>
        <Description>string</Description>
        <Code>long</Code>
        <SubCode>long</SubCode>
        <RecoverableError>boolean</RecoverableError>
        <SubModuleName>string</SubModuleName>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <DatabaseInformation>string</DatabaseInformation>
        <DatabaseServer>string</DatabaseServer>
        <DatabaseName>string</DatabaseName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <GetPersonResponse xmlns="http://healthXML.org/PasLink">
      <Person>
        <Id>
          <OfficialId>
            <Value>string</Value>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </OfficialId>
        </Id>
        <Name>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <FirstName>string</FirstName>
          <GivenName>string</GivenName>
        </Name>
        <Address>
          <County>
            <Code>string</Code>
            <Name>string</Name>
          </County>
          <UrbanNeighbourhood>
            <Code>string</Code>
            <Name>string</Name>
          </UrbanNeighbourhood>
          <HouseProperty>string</HouseProperty>
          <District>string</District>
          <BillingDistrict>string</BillingDistrict>
        </Address>
        <PersonalInformation>
          <PersonSecurity>boolean</PersonSecurity>
        </PersonalInformation>
      </Person>
    </GetPersonResponse>
  </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 /PasLinkWS/PersonWS/PersonWS.asmx HTTP/1.1
Host: linkws.service.tieto.com
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:Header>
    <RequestHeader xmlns="http://healthXML.org/PasLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPerson xmlns="http://healthXML.org/PasLink">
      <OfficialId>string</OfficialId>
      <TypeOfId>string</TypeOfId>
    </GetPerson>
  </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:Header>
    <ResponseHeader xmlns="http://healthXML.org/PasLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <ErrorInformation>
        <FunctionName>string</FunctionName>
        <Severity>None or Critical or Warning or Information</Severity>
        <ErrorType>string</ErrorType>
        <ModuleName>string</ModuleName>
        <Description>string</Description>
        <Code>long</Code>
        <SubCode>long</SubCode>
        <RecoverableError>boolean</RecoverableError>
        <SubModuleName>string</SubModuleName>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <DatabaseInformation>string</DatabaseInformation>
        <DatabaseServer>string</DatabaseServer>
        <DatabaseName>string</DatabaseName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPersonResponse xmlns="http://healthXML.org/PasLink">
      <Person>
        <Id>
          <OfficialId>
            <Value>string</Value>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </OfficialId>
        </Id>
        <Name>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <FirstName>string</FirstName>
          <GivenName>string</GivenName>
        </Name>
        <Address>
          <County>
            <Code>string</Code>
            <Name>string</Name>
          </County>
          <UrbanNeighbourhood>
            <Code>string</Code>
            <Name>string</Name>
          </UrbanNeighbourhood>
          <HouseProperty>string</HouseProperty>
          <District>string</District>
          <BillingDistrict>string</BillingDistrict>
        </Address>
        <PersonalInformation>
          <PersonSecurity>boolean</PersonSecurity>
        </PersonalInformation>
      </Person>
    </GetPersonResponse>
  </soap12:Body>
</soap12:Envelope>