BookingWS Web Service

BookingWS

Click here for a complete list of operations.

GetScheduleTemplate

Get a specific schedule templates or getting a set of schedule templates for a unit

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

<?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>
        <Value xmlns="">string</Value>
        <TypeOfId xmlns="">string</TypeOfId>
        <FormattedId xmlns="">string</FormattedId>
      </AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap:Header>
  <soap:Body>
    <GetScheduleTemplate xmlns="http://healthXML.org/PasLink">
      <getScheduleTemplateRequest>
        <Unit>
          <Id>string</Id>
          <TypeOfId>string</TypeOfId>
          <ShortNameId>string</ShortNameId>
          <Name>string</Name>
        </Unit>
        <Template>
          <Code>string</Code>
          <Text>string</Text>
        </Template>
        <ScheduleTemplateId>string</ScheduleTemplateId>
      </getScheduleTemplateRequest>
    </GetScheduleTemplate>
  </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>
        <Value xmlns="">string</Value>
        <TypeOfId xmlns="">string</TypeOfId>
        <FormattedId xmlns="">string</FormattedId>
      </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>
    <GetScheduleTemplateResponse xmlns="http://healthXML.org/PasLink">
      <GetScheduleTemplateResult>
        <ScheduleTemplate>
          <ScheduleTemplateId>string</ScheduleTemplateId>
          <Unit>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
          </Unit>
          <Template>
            <Code>string</Code>
            <Text>string</Text>
          </Template>
          <TemplateType>NotSet or Fixed or Open</TemplateType>
          <ValidForTimeOfDay>NotSet or AllDay or BeforeDinner or Afternoon</ValidForTimeOfDay>
          <StartEndTime>
            <FromTime>dateTime</FromTime>
            <ToTime>dateTime</ToTime>
          </StartEndTime>
          <PauseTime>
            <FromTime>dateTime</FromTime>
            <ToTime>dateTime</ToTime>
          </PauseTime>
          <ScheduleTemplates>
            <ScheduleTemplateRowId>string</ScheduleTemplateRowId>
            <RowNo>int</RowNo>
            <ValidNumberOfDays>int</ValidNumberOfDays>
          </ScheduleTemplates>
          <ScheduleTemplates>
            <ScheduleTemplateRowId>string</ScheduleTemplateRowId>
            <RowNo>int</RowNo>
            <ValidNumberOfDays>int</ValidNumberOfDays>
          </ScheduleTemplates>
          <ScheduleTypes>
            <Type>string</Type>
            <Count>int</Count>
          </ScheduleTypes>
          <ScheduleTypes>
            <Type>string</Type>
            <Count>int</Count>
          </ScheduleTypes>
          <Overbooking>
            <NumberOfOverbookings>int</NumberOfOverbookings>
            <TimeForOverbooking>int</TimeForOverbooking>
          </Overbooking>
          <Registration>
            <Institution xsi:nil="true" />
          </Registration>
          <Update>
            <UpdateCount>int</UpdateCount>
          </Update>
        </ScheduleTemplate>
      </GetScheduleTemplateResult>
    </GetScheduleTemplateResponse>
  </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/BookingWS/BookingWS.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>
        <Value xmlns="">string</Value>
        <TypeOfId xmlns="">string</TypeOfId>
        <FormattedId xmlns="">string</FormattedId>
      </AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap12:Header>
  <soap12:Body>
    <GetScheduleTemplate xmlns="http://healthXML.org/PasLink">
      <getScheduleTemplateRequest>
        <Unit>
          <Id>string</Id>
          <TypeOfId>string</TypeOfId>
          <ShortNameId>string</ShortNameId>
          <Name>string</Name>
        </Unit>
        <Template>
          <Code>string</Code>
          <Text>string</Text>
        </Template>
        <ScheduleTemplateId>string</ScheduleTemplateId>
      </getScheduleTemplateRequest>
    </GetScheduleTemplate>
  </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>
        <Value xmlns="">string</Value>
        <TypeOfId xmlns="">string</TypeOfId>
        <FormattedId xmlns="">string</FormattedId>
      </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>
    <GetScheduleTemplateResponse xmlns="http://healthXML.org/PasLink">
      <GetScheduleTemplateResult>
        <ScheduleTemplate>
          <ScheduleTemplateId>string</ScheduleTemplateId>
          <Unit>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
          </Unit>
          <Template>
            <Code>string</Code>
            <Text>string</Text>
          </Template>
          <TemplateType>NotSet or Fixed or Open</TemplateType>
          <ValidForTimeOfDay>NotSet or AllDay or BeforeDinner or Afternoon</ValidForTimeOfDay>
          <StartEndTime>
            <FromTime>dateTime</FromTime>
            <ToTime>dateTime</ToTime>
          </StartEndTime>
          <PauseTime>
            <FromTime>dateTime</FromTime>
            <ToTime>dateTime</ToTime>
          </PauseTime>
          <ScheduleTemplates>
            <ScheduleTemplateRowId>string</ScheduleTemplateRowId>
            <RowNo>int</RowNo>
            <ValidNumberOfDays>int</ValidNumberOfDays>
          </ScheduleTemplates>
          <ScheduleTemplates>
            <ScheduleTemplateRowId>string</ScheduleTemplateRowId>
            <RowNo>int</RowNo>
            <ValidNumberOfDays>int</ValidNumberOfDays>
          </ScheduleTemplates>
          <ScheduleTypes>
            <Type>string</Type>
            <Count>int</Count>
          </ScheduleTypes>
          <ScheduleTypes>
            <Type>string</Type>
            <Count>int</Count>
          </ScheduleTypes>
          <Overbooking>
            <NumberOfOverbookings>int</NumberOfOverbookings>
            <TimeForOverbooking>int</TimeForOverbooking>
          </Overbooking>
          <Registration>
            <Institution xsi:nil="true" />
          </Registration>
          <Update>
            <UpdateCount>int</UpdateCount>
          </Update>
        </ScheduleTemplate>
      </GetScheduleTemplateResult>
    </GetScheduleTemplateResponse>
  </soap12:Body>
</soap12:Envelope>