Relaties opvragen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Relaties opvragen

Aanroep

Naam: GetRelations

 

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:GetRelations xmlns:ns2="https://api.stip-t.nl/v1/">

    <securityToken></securityToken>

    <filters>

       <filter>

         <field></field>

         <operator></operator>

         <value></value>

       <filter>

       ...

     </filters>

     <orderBy></orderBy>

  </ns2:GetRelations>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

filters

List<Filter>

LET OP:

indien geen filters dan worden ALLE relaties opgehaald

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

zie Filter

orderBy

string

sortering, komma gescheiden lijst van veldnamen. Een veldnaam kan gevolgd worden door sleutelwoord ASC (oplopend, default) of DESC (aflopend).

B.v.: countryCode, city DESC

 

Antwoord

Naam: GetRelationsResponse

 

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:GetRelationsResponse xmlns:ns2="https://api.stip-t.nl/v1/">

    <result>

      <error></error>

      <errorMessage/>

      <relationList>

        <relation>

          <relationNo></relationNo>

          <name></name>

          <contact></contact>

          <address></address>

          <postalCode></postalCode>

          <city></city>

          <countryCode></countryCode>

          <IBAN></IBAN>

          <BIC></BIC>

          <commerceNo></commerceNo>

          <taxNo></taxNo>

          <OIN></OIN>

          <email></email>

          <telephone></telephone>

          <relationType></relationType>

           <userFieldList>

            <userField>

              <key></key>

              <value></value>

            </userField>

             ...

          </userFieldList>

        </relation>

      </relationList>

    </result>

  </ns2:GetRelationsResponse>

</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

relationList

RelationList

Tag/veldnaam

Type

relation

Relation

Tag/veldnaam

Type

Omschrijving

relationNo

string

relatienummer

name

string

naam

contact

string

contactpersoon

address

string

adres

postalCode

string

postcode

city

string

plaats

countryCode

string

landcode

IBAN

string

bankrekeningnummer

BIC

string

BIC

commerceNo

string

K.v.K. nummer

taxNo

string

BTW nummer

OIN

string

organisatie-identificatienummer overheidsorganisatie

email

string

e-mail adres

telephone

string

telefoonnummer

relationType

string

relatietype

userFieldList

List<UserField>

Een relatie kan gebruikersvelden bevatten, zie UserField