Application Broker 3.7 File Service
Click
here
for a complete list of operations.
listFiles
Returns a list of files (identifier, title, MIME type and URL) for a given owner and category.
Owner
must be an authority id.Category
must be a value from the 'file-category' value list.
This operation is valid for both applicants and authorities.
Test
The test form is not available with struct, array or byref parameter types. Please use a SOAP 1.1 or 1.2 compliant client program for testing of your web service.
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 /broker/3.7/files.wso HTTP/1.1
Host: ab.vd.dk
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<listFiles xmlns="http://services.vd.dk/2010/applicationbroker/">
<Request>
<LoginToken>string</LoginToken>
<Owner>long</Owner>
<Category>string</Category>
</Request>
</listFiles>
</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:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<listFilesResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
<listFilesResult>
<Meta>
<Success>boolean</Success>
<Errors>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
</Errors>
</Meta>
<Files>
<tFile>
<FileIdentifier>int</FileIdentifier>
<Title>string</Title>
<MimeCode>string</MimeCode>
<URL>string</URL>
</tFile>
<tFile>
<FileIdentifier>int</FileIdentifier>
<Title>string</Title>
<MimeCode>string</MimeCode>
<URL>string</URL>
</tFile>
</Files>
</listFilesResult>
</listFilesResponse>
</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 /broker/3.7/files.wso HTTP/1.1
Host: ab.vd.dk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<listFiles xmlns="http://services.vd.dk/2010/applicationbroker/">
<Request>
<LoginToken>string</LoginToken>
<Owner>long</Owner>
<Category>string</Category>
</Request>
</listFiles>
</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:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<listFilesResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
<listFilesResult>
<Meta>
<Success>boolean</Success>
<Errors>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
</Errors>
</Meta>
<Files>
<tFile>
<FileIdentifier>int</FileIdentifier>
<Title>string</Title>
<MimeCode>string</MimeCode>
<URL>string</URL>
</tFile>
<tFile>
<FileIdentifier>int</FileIdentifier>
<Title>string</Title>
<MimeCode>string</MimeCode>
<URL>string</URL>
</tFile>
</Files>
</listFilesResult>
</listFilesResponse>
</soap12:Body>
</soap12:Envelope>
JSON
The following is a sample JSON request and response. The placeholders shown need to be replaced with actual values.
POST /broker/3.7/files.wso/listFiles HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Request": {
"LoginToken": string,
"Owner": long,
"Category": string
}
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Meta": {
"Success": boolean,
"Errors": [
{
"ErrorCode": int,
"ErrorText": string
},
{
"ErrorCode": int,
"ErrorText": string
}
]
},
"Files": [
{
"FileIdentifier": int,
"Title": string,
"MimeCode": string,
"URL": string
},
{
"FileIdentifier": int,
"Title": string,
"MimeCode": string,
"URL": string
}
]
}