WEB SERVICE GRÄNSSNITT 02.05.2014
Innehållsförteckning 2 (13) 02.05.2014 Innehållsförteckning 1 SOAP-ram... 4 2 Packning av betalningsmaterial... 4 3 Kryptering av betalningsmaterial... 4 4 Stödda operationer... 4 5 Application Request Header... 4 5.1 SenderId... 4 5.2 RequestId... 4 5.3 Timestamp... 4 5.4 Language... 4 5.5 UserAgent... 5 5.6 ReceiverId... 5 6 Använda element i Application Request meddelandet... 5 6.1 CustomerId... 5 6.2 Command... 5 6.3 Timestamp... 5 6.4 StartDate... 5 6.5 EndDate... 5 6.6 Status... 5 6.7 ServiceId... 5 6.8 Environment... 5 6.9 FileReferences/FileReference... 6 6.10 UserFileName... 6 6.11 TargetId... 6 6.12 ExecutionSerial... 6 6.13 Encryption... 6 6.14 EncryptionMethod... 6 6.15 Compression... 6 6.16 CompressionMethod... 6 6.17 AmountTotal... 6 6.18 TransactionCount... 6 6.19 SoftwareId... 7 6.20 CustomerExtension... 7 6.21 FileType... 7 6.22 Content... 7 6.23 Signature... 7 7 Application Responses element... 7 7.1 CustomerId... 7 7.2 Timestamp... 7 7.3 ResponseCode... 7
Innehållsförteckning 3 (13) 02.05.2014 7.4 ResponseText... 8 7.5 ExecutionSerial... 8 7.6 Encrypted... 8 7.7 EncryptionMethod... 8 7.8 Compressed... 8 7.9 CompressionMethod... 8 7.10 AmountTotal... 8 7.11 TransactionCount... 8 7.12 CustomerExtension... 8 7.13 FileDescriptors... 8 7.13.1 FileDescriptor... 8 7.14 UserFileTypes... 9 7.15 Content... 9 7.16 Signature... 9 8 Exempelmeddelanden... 10 8.1 SOAP-förfrågan (uploadfile)... 10 8.2 Application Request UploadFile... 11 8.3 Application Request DownloadFileList... 12 8.4 Application Request DownloadFile... 13
4 (13) 1 SOAP-ram Vi tar emot SEPA-material i WS-kanalen endast i SOAP-meddelanden. I SOAP-meddelandets rubrik ska det finnas signatur i elementet WS-Security. 2 Packning av betalningsmaterial Samlinks systemlösning stöder packning av material i enlighet med RFC 1952. Värdet i fältet CompressionMethod är då GZIP och i elementet Compression true. 3 Kryptering av betalningsmaterial Separat kryptering av betalningsmaterial stöds inte (elementen EncryptionMethod och Encryption). 4 Stödda operationer Stödda uploadfile downloadfilelist downloadfile deletefile Inte stödda getuserinfo o returnerar felkoden 05, (getuserinfo not supported) 5 Application Request Header I Application Request finns element vars användning preciseras nedan. 5.1 SenderId Avsändarens unika identifikationskod d.v.s. WS-användarkoden. Den överläts till före-taget när avtalet undertecknades. 5.2 RequestId Försändelsens unika identifikationskod. Material som kommer under samma dygn ska ha ett unikt värde. Om värdet har använts tidigare förkastas meddelandet som duplikat. 5.3 Timestamp Tidsstämpel som anger när Application Request Header har skapats. 5.4 Language Finska: FI Svenska: SV
5 (13) Engelska: EN 5.5 UserAgent 5.6 ReceiverId Inte i användning 6 Använda element i Application Request meddelandet 6.1 CustomerId Unik identifkationskod d.v.s. servicekod för den som bildar materialet. Den överläts till företaget när avtalet undertecknades. 6.2 Command Värdet ska motsvara SOAP-operationen. 6.3 Timestamp Tidsstämpel som anger när Application Request har skapats 6.4 StartDate Vi läser elementets värde endast för operationerna: DownloadFileList. 6.5 EndDate Vi läser elementets värde endast för operationerna: DownloadFileList. 6.6 Status Vi läser elementets värde endast för operationerna: DownloadFileList. Vi stöder koderna NEW, DLD, ALL. 6.7 ServiceId Inte i användning 6.8 Environment Vi stöder: PRODUCTION och TEST I testmiljön används produktionens koder men materialen går inte till betalning.
6 (13) 6.9 FileReferences/FileReference Vi läser elementets värde endast för operationerna: DownloadFile och DeleteFile. Endast för returdata. Max 50 Filereference-element i ett meddelade tillåtet. 6.10 UserFileName Vi läser elementets värde endast för operationerna: UploadFile 6.11 TargetId Stöds i enlighet med definitionen. 6.12 ExecutionSerial Inte i användning. 6.13 Encryption Inte i användning. 6.14 EncryptionMethod Inte i användning. 6.15 Compression Stöds, värdet antingen true eller false. 6.16 CompressionMethod Om den används är värdet GZIP 6.17 AmountTotal Vi läser elementets värde endast för operationerna: UploadFile. Om elementet finns och om FileType är XL, jämför vi fältets värde med betalningsmaterialets summa. Om FileType är XL, återställer vi i response rätt värde i det här fältet, fast-än client inte skulle ha räknat det. 6.18 TransactionCount Vi läser elementets värde endast för operationerna: UploadFile. För betalningsmaterialet XL jämför vi värdet i det här elementet med be-talningsmaterialets summa. Om betalningsmaterialet är XL, återställer vi i response det rätta värdet i det här fältet, fastän kundens tillämpning inte skulle ha räknat det.
7 (13) 6.19 SoftwareId Uppgift om programvaran och dess version som kundens tillämpning skickat. 6.20 CustomerExtension Inte i användning. 6.21 FileType Vi läser elementets värde endast för operationerna: UploadFile, DownloadFile och DownloadFile- List. Lista på stödda materialtyper i tjänstebeskrivningen för Web Services-förbindelsen. 6.22 Content Vi läser elementets värde endast för operationerna: UploadFile 6.23 Signature Alla meddelanden ska vara signerade. 7 Application Responses element 7.1 CustomerId Kundens servicekod. 7.2 Timestamp Tidsstämpel utgående från vilken man kan konstatera att ett material har gått ut. (Vid genomförandeskedet utreds vilket värde som är lämpligt). 7.3 ResponseCode Kod Förklaring 00 OK 05 OKÄND TILLÄMPNINGSFÖRFRÅGAN 12 DEN FORMELLA GRANSKNINGEN AV MATERIALET MISSLYCKADES 21 PACNINGEN AV MATERIALET FELAKTIG 25 MATERIALET INTE TILLÅTET 26 TEKNISKT FEL 27 MATERIALET KAN INTE TAS BORT 30 IDENTIFIERINGEN MISSLYCKADES 32 DUBBELFÖRSÄNDELSE
8 (13) 7.4 ResponseText Se ovan 7.5 ExecutionSerial Används inte 7.6 Encrypted Används inte 7.7 EncryptionMethod Används inte 7.8 Compressed Vi stöder packande i enlighet med definitionen 7.9 CompressionMethod Vi stöder i enlighet med RFC 1952 7.10 AmountTotal Se förklaringen av request 7.11 TransactionCount Se förklaringen av request 7.12 CustomerExtension Inte i användning 7.13 FileDescriptors Vi returnerar elementet endast: DownloadFileList 7.13.1 FileDescriptor Vi returnerar elementet endast: DownloadFileList FileReference (alltid) TargetId (alltid) ServiceId (används inte) ServiceIdOwnerName (används inte) UserFileName (alltid) ParentFileReference (om det är fråga om returdata)
9 (13) FileType (alltid) FileTimestamp (alltid) Status (alltid) AmountTotal (alltid) TransactionCount (alltid) LastDownloadTimestamp (ges returdata om inte tom) ForwardedTimestamp (återges materialet om inte tom) Confirmable (används inte) Deletable (används inte) SubStatusCode (används inte) SubStatusText (används inte) MissingTransactions (används inte) SubType (används inte) FeedbackFileAttributes (används inte) 7.14 UserFileTypes Vi stöder inte GetUserInfo-operationen och återsänder därmed inte UserFileTypes-elementet. 7.15 Content Vi återsänder elementet endast: DownloadFile Om man i kundsökningen ber om flera filer finns filernas innehåll efter varandra i Con-tent. 7.16 Signature Vi signerar alla svar
10 (13) 8 Exempelmeddelanden 8.1 SOAP-förfrågan (uploadfile)
11 (13) 8.2 Application Request UploadFile
12 (13) 8.3 Application Request DownloadFileList
13 (13) 8.4 Application Request DownloadFile