Urenboekingen opvragen

<< Click to Display Table of Contents >>

Navigation:  API aanroepen >

Urenboekingen opvragen

Aanroep

Naam: GetBookings

 

Aanroep structuur

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetBookings xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <startDate></startDate>

    <endDate></endDate>

    <filters>

      <filter>

        <field></field>

        <operator></operator>

        <value></value>

      </filter>

       ...

    </filters>

  </ns2:GetBookings>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

startDate

date

verplicht

formaat: yyyy-mm-dd

boekingen opvragen vanaf datum.

 

endDate

date

verplicht

formaat: yyyy-mm-dd

boekingen opvragen tot en met datum

filters

List<Filter>

optioneel

Naast het startDate/endDate filter kan via deze filters op specifieke urenboeking eigenschappen worden gefilterd.

filterlijst voor Booking velden (zie hieronder in de Antwoord structuur en Verklaring)

zie Filter

Voor ophalen van gewijzigde gegevens zie: Filter -> Voorbeeld

 

Limiet

Er kunnen maximaal 10000 boekingen per bevragen worden teruggestuurd. Beperk de startDate en endDate, zodat er niet teveel boekingen in 1 keer worden opgehaald (bijv. per dag of maand).

Indien de opgegeven periode (startDate en endDate) meer dan 10000 boekingen zal opleveren, worden er geen boekingen teruggegeven en wordt het gemeld in het veld errorMessage van het antwoord.

 

 

Voorbeeld

hmtoggle_arrow1Urenboekingen ophalen

 

Het volgende voorbeeld zal alle uren ophalen die gemaakt zijn in heel januari 2018.

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetBookings xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <startDate>2018-01-01</startDate>

    <endDate>2018-01-31</endDate>

  </ns2:GetBookings>

</S:Body>

</S:Envelope>

 

 

Antwoord

Naam: GetBookingsResponse

 

Antwoord structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetBookingsResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <bookingList>

        <booking>

          <id></id>

          <start></start>

          <duration></duration>

          <approvalLevel></approvalLevel>

          <leaveState></leaveState>

          <invoiced></invoiced>

          <tariff></tariff>

          <timestamp></timestamp>

          <id_IT_MED></id_IT_MED>

          <id_GR_MED></id_GR_MED>

           <id_IT_TAA></id_IT_TAA>

          <id_IT_AT1></id_IT_AT1>

          <id_IT_AT2></id_IT_AT2>

          <id_IT_AT3></id_IT_AT3>

          <id_IT_AT4></id_IT_AT4>

          <id_IT_AT5></id_IT_AT5>

          <name_IT_MED></name_IT_MED>

          <name_GR_MED></name_GR_MED>

          <name_IT_AT1></name_IT_AT1>

          <name_IT_AT2></name_IT_AT2>

          <name_IT_AT3></name_IT_AT3>

          <name_IT_AT4></name_IT_AT4>

          <name_IT_AT5></name_IT_AT5>

          <userFieldList>

            <userField>

              <key></key>

              <value></value>

            </userField>

             ...

        </booking>

         ...

      </bookingList>

    </result>

  </ns2:GetBookingsResponse>

</S:Body>

</S:Envelope>

 

 

Verklaring

Tag/veldnaam

Type

result

RequestResult

Tag/veldnaam

Type

Omschrijving

error

boolean

false indien geen fouten, true indien er fouten zijn opgetreden

errorMessage

string

foutboodschap, alleen gevuld indien error = true

bookingList

List<Booking>

een lijst van bookingen