DigiOffice Gateway Web Services

<back to all web services

GetPrefilterDescription

Requires Authentication
GetPrefilterDescription Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileFieldIDqueryGuidNo
PrefilterDescriptionResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPrefilterDescription HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPrefilterDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Controls.Operations">
  <RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
</GetPrefilterDescription>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PrefilterDescriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Controls.Operations">
  <Description>String</Description>
</PrefilterDescriptionResponse>