WsrmService (Version 3, 2018-4)

Siden opdateres automatisk til at afspejle koden.

Denne service gør det muligt for webserviceaftagerne at hente og kvittere for modtagelsen af beskeder fra DFDG. Se også den tværgående beskrivelse om Modtagelse af WSRM beskeder.

Metoder

CreateSequence

Denne metode benyttes til at initiere en WSRM overførsel af meddelelser. Der returneres en beskrivelse af hvilke meddelelser, der er klar til afhentning (service inventory), der returneres højes 500 beskeder pr. afhentning.

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateSequence

CreateSequenceType

 

1

 

-    AcksTo

EndpointReferenceType

 

0 - 1

WS-Addressing end point, hvortil bekræftelser skal sendes (Bruges ikke af servicen, da det er klienten, der sender bekræftelser – men skal medtages alligevel for at overholde WS-RM skemaer).

-    -    Address

AttributedURI

 

0 - 1

 

-    -    ReferenceProperties

ReferencePropertiesType

 

0 - 1

 

-    -    ReferenceParameters

ReferenceParametersType

 

0 - 1

 

-    -    PortType

AttributedQName

 

0 - 1

 

-    -    ServiceName

ServiceNameType

 

0 - 1

Navn på fremsøgt service.

-    Expires

 

 

0 - 1

 

-    Offer

OfferType

 

0 - 1

 

-    -    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

 

-    -    Expires

 

 

0 - 1

 

-    SubQueueIdentifier

int

 

0 - 1

Id på underkø. Hvis subqueueidentifier ikke er angivet, så default'er systemet til hovedkøen.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateSequenceResponse

CreateSequenceResponseType

 

1

 

-    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik sekvens-id, der skal benyttes i forbindelsen med al øvrig kommunikation inden for denne sequence.

-    ServiceInventoryCollection

ArrayOfServiceItem

 

0 - 1

Beskrivelse af meddelelser der er klar til afhentning.

-    -    ServiceItem

ServiceItem

 

0 - *

Meddelelsestype der er klar til afhentning.

-    -    -    ServiceName

string

 

0 - 1

Metodenavn på den WSRM GetXXX operation der skal kaldes.

-    -    -    ServiceEndpoint

string

 

0 - 1

URL til webservice.

-    -    -    MessageCount

int

 

1

Antal beskeder af den type

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4006

Create sequence refused

Create WS-RM Sequence refused, open sequence exists

9182

The user is not authorized to read messages on this queue

The user is not authorized to read messages on this queue

CloseSequence

Denne metode benyttes til at afbryde en pålidelig overførsel inden normal afslutning. Hele overførslen betragtes som annulleret, og serveren vil derfor ikke slette beskeder, som er blevet sendt i den pågældende overførsel, ligesom aftageren vil få disse sendt beskeder igen ved næste overførsel.

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CloseSequence

CloseSequenceType

 

1

 

-    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unikt sekvens-id, leveret som output af kaldet til "CreateSequence".

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CloseSequenceResponse

CloseSequenceResponseType

 

1

 

-    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unikt sekvens-id, leveret som output af kaldet til "CreateSequence".

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4001

Sequence is terminated

The WS-RM Sequence Status is set to terminated

4002

Sequence is faulted

The WS-RM Sequence Status is set to Faulted

4003

Sequence is ended

The WS-RM Sequence Status is set to Ended

4004

Sequence is None

The WS-RM Sequence Status is set to None

TerminateSequence

Denne metode benyttes til at afslutte en korrekt gennemført overførsel efter det er konstateret, at alle meddelelser i overførslen er modtaget korrekt.

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

TerminateSequence

TerminateSequenceType

 

1

 

-    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unikt sekvens-id, leveret som output af kaldet til "CreateSequence".

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

TerminateSequenceResponse

TerminateSequenceResponseType

 

1

 

-    Identifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unikt sekvens-id, leveret som output af kaldet til "CreateSequence".

-    TerminateSequenceCorrect

boolean

 

1

Om overførslen er afsluttet korrekt.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4001

Sequence is terminated

The WS-RM Sequence Status is set to terminated

4002

Sequence is faulted

The WS-RM Sequence Status is set to Faulted

4003

Sequence is ended

The WS-RM Sequence Status is set to Ended

4004

Sequence is None

The WS-RM Sequence Status is set to None