Poniższy diagram prezentuje scenariusz subskrypcji aplikacji do usługi CallEventNotifications.

Transkrypt

1 Poniższy diagram prezentuje scenariusz subskrypcji aplikacji do usługi CallEventNotifications. Rys. 2 Subskrypcja do usługi CallEventNotifications Opis diagramu sekwencji: 1. Aplikacja dokonuje subskrypcji do usługi CallEventNotifications poprzez użycie komendy POST, i otrzymuje zasób URL zawierający wartość subscriptionid.

2 2. W momencie kiedy pojawia się zdarzenie spełniający zdefiniowane kryteria, wtedy Serwer informuje Aplikację poprzez użycie komendy POST. 3. Aplikacja zatrzymuje usługę poprzez komendę DELETE z użyciem zasobu URL, który zawiera wartość subcriptionid. Poniższy diagram prezentuje scenariusz subskrypcji aplikacji do usługi CallDirectionNotifications. Rys. 3 Subskrypcja do usługi CallDirectionNotifications

3 Opis diagramu sekwencji: 1. Aplikacja dokonuje subskrypcji do usługi CallDirectionNotifications poprzez użycie komendy POST, i otrzymuje zasób URL zawierający wartość subscriptionid. 2. W momencie kiedy pojawia się zdarzenie spełniający zdefiniowane kryteria, wtedy Serwer informuje Aplikację poprzez użycie komendy POST. 3. Aplikacja zatrzymuje usługę poprzez komendę DELETE z użyciem zasobu URL, który zawiera wartość subcriptionid. Poniższy diagram prezentuje scenariusz subskrypcji aplikacji do usługi MediaInteractionNotifications. Rys. 4 Subskrypcja do usługi MediaInteractionNotifications

4 Opis diagramu sekwencji: 1. Aplikacja dokonuje subskrypcji do usługi MediaInteractionNotifications poprzez użycie komendy POST, i otrzymuje zasób URL zawierający wartość subscriptionid. 2. W momencie kiedy pojawia się zdarzenie spełniający zdefiniowane kryteria, wtedy Serwer informuje Aplikację poprzez użycie komendy POST. 3. Aplikacja zatrzymuje usługę poprzez komendę DELETE z użyciem zasobu URL, który zawiera wartość subcriptionid. 4. Zasoby związane z subskrypcją dotyczącą usługi CallNotification Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu CallEvents Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać 4.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu CallEvents.

5 GET /exampleapi/1/callnotification/subscriptions HTTP/1.1

6 HTTP/ OK <cn:callnotificationsubscriptionlist xmlns:cn="urn:oma:xml:rest:callnotification:1"> <calleventsubscription> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> <resourceurl> ourceurl> </calleventsubscription> <calleventsubscription> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>012345</clientcorrelator> <resourceurl> ourceurl> </calleventsubscription> <calldirectionsubscription> <notifyurl> <filter>

7 <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>212345</clientcorrelator> <resourceurl> rection/sub001</resourceurl> </calldirectionsubscription> <playandcollectinteractionsubscription> <notifyurl> URL</notifyURL> <callsessionidentifier>a1234</callsessionidentifier> <clientcorrelator>312345</clientcorrelator> <resourceurl> tion/sub001</resourceurl> </playandcollectinteractionsubscription> <playandcollectinteractionsubscription> <notifyurl> URL</notifyURL> <callsessionidentifier>a5678</callsessionidentifier> <clientcorrelator>412345</clientcorrelator> <resourceurl> ding/sub001</resourceurl> </playandcollectinteractionsubscription> <resourceurl> urceurl> </cn:callnotificationsubscriptionlist> <resourceurl> ding/sub001</resourceurl> </playandcollectinteractionsubscription> <resourceurl> urceurl> </cn:callnotificationsubscriptionlist> 4.3. PUT powinien odpowiedzieć Allow:GET POST powinien odpowiedzieć Allow:GET.

8 4.5. DELETE powinien odpowiedzieć Allow:GET. 5. Zasoby związane z subskrypcją dotyczącą usługi CallEventNotification Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu CallEvents Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać 5.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu CallEvents. GET /exampleapi/1/callnotification/subscriptions/callevent HTTP/1.1

9 HTTP/ OK <cn:callnotificationsubscriptionlist xmlns:cn="urn:oma:xml:rest:callnotification:1"> <calleventsubscription> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> <resourceurl> ourceurl> </calleventsubscription> <calleventsubscription> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>012345</clientcorrelator> <resourceurl> ourceurl> </calleventsubscription> <resourceurl> </cn:callnotificationsubscriptionlist> 5.3. PUT powinien odpowiedzieć Allow:GET, POST POST Operacja ta jest używana w celu utworzenia nowej subskrypcji do usługi informowania o zdarzeniach typu CallEvent.

10 Tworzenie nowej subskrypcji do usługi informowania o zdarzeniach typu CallEvent z odpowiedzią zawierającą kopię utworzonego zasobu. POST /exampleapi/1/callnotification/subscriptions/callevent HTTP/1.1 <cn:calleventsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> RL> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> </cn:calleventsubscription> HTTP/ Created Location: <cn:calleventsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> RL> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> <resourceurl> vent/sub001</resourceurl> </cn:calleventsubscription>

11 Tworzenie nowej subskrypcji do usługi informowania o zdarzeniach typu CallEvent z odpowiedzią zawierającą lokalizację utworzonego zasobu POST /exampleapi/1/callnotification/subscriptions/callevent HTTP/1.1 <cn:calleventsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> RL> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> </cn:calleventsubscription> HTTP/ Created Location: <common:resourcereference xmlns:common="urn:oma:xml:rest:common:1"> <resourceurl> vent/sub001</resourceurl> </common:resourcereference> 5.5. DELETE powinien odpowiedzieć Allow:GET, POST.

12 6. Zasoby związane z indywidualną subskrypcją dotyczącą usługi CallEventNotifications Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu CallEventNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać subscriptionid Identyfikator subskrypcji 6.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu CallEventNotifications. GET /exampleapi/1/callnotification/subscriptions/callevent/sub001?resformat=xml HTTP/1.1

13 HTTP/ OK <cn:calleventsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>answer</criteria> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>112345</clientcorrelator> <resourceurl> ourceurl> </cn:calleventsubscription> 6.3. PUT powinien odpowiedzieć Allow:GET, DELETE POST powinien odpowiedzieć Allow:GET, DELETE DELETE Operacja ta jest użyta w celu anulowania subskrypcji i zatrzymania usługi. DELETE /exampleapi/1/callnotification/subscriptions/callevent/sub001 HTTP/1.1

14 HTTP/ No Content 7. Zasoby związane z subskrypcją dotyczącą usługi CallDirectionNotifications Użyty zasób to: Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu CallDirectionNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać 7.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu CallDirectionNotifications.

15 GET /exampleapi/1/callnotification/subscriptions/calldirection HTTP/1.1 HTTP/ OK <cn:callnotificationsubscriptionlist xmlns:cn="urn:oma:xml:rest:callnotification:1"> <calldirectionsubscription> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>212345</clientcorrelator> <resourceurl> resourceurl> </calldirectionsubscription> <resourceurl> eurl> </cn:callnotificationsubscriptionlist> 7.3. PUT powinien odpowiedzieć Allow:GET, POST.

16 7.4. POST POST /exampleapi/1/callnotification/subscriptions/calldirection HTTP/1.1 <cn:calldirectionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>212345</clientcorrelator> </cn:calldirectionsubscription> HTTP/ Created Location: <cn:calldirectionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>212345</clientcorrelator> <resourceurl> resourceurl> </cn:calldirectionsubscription>

17 7.5. DELETE powinien odpowiedzieć Allow:GET, POST. 8. Zasoby związane z indywidualną subskrypcją dotyczącą usługi CallDirectionNotifications Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu CallDirectionNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać subscriptionid Identyfikator subskrypcji 8.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu CallDirectionNotifications.

18 GET /exampleapi/1/callnotification/subscriptions/calldirection/sub001 HTTP/1.1 HTTP/ OK <cn:calldirectionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <filter> <address>tel: </address> <address>tel: </address> <criteria>busy</criteria> <addressdirection>called</addressdirection> </filter> <clientcorrelator>212345</clientcorrelator> <resourceurl> resourceurl> </cn:calldirectionsubscription> 8.3. PUT powinien odpowiedzieć Allow:GET, DELETE POST powinien odpowiedzieć Allow:GET, DELETE DELETE Operacja ta jest użyta w celu anulowania subskrypcji i zatrzymania usługi.

19 DELETE /exampleapi/1/callnotification/subscriptions/calldirection/sub001 HTTP/1.1 HTTP/ No Content 9. Zasoby związane z subskrypcją dotyczącą usługi Play- And- Collect Media Interaction Notifications Użyty zasób to: Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu PlayAndCollectMediaInteractionNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać

20 9.2. GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu PlayAndCollectMediaInteractionNotifications. GET /exampleapi/1/callnotification/subscriptions/collection HTTP/1.1 HTTP/ OK <cn:callnotificationsubscriptionlist xmlns:cn="urn:oma:xml:rest:callnotification:1"> <playandcollectinteractionsubscription> <notifyurl> <callsessionidentifier>a1234</callsessionidentifier> <clientcorrelator>312345</clientcorrelator> <resourceurl> ourceurl> </playandcollectinteractionsubscription> <resourceurl> RL> </cn:callnotificationsubscriptionlist> 9.3. PUT powinien odpowiedzieć Allow:GET, POST.

21 9.4. POST POST /exampleapi/1/callnotification/subscriptions/collection HTTP/1.1 <cn:playandcollectinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a1234</callsessionidentifier> <clientcorrelator>312345</clientcorrelator> </cn:playandcollectinteractionsubscription> HTTP/ Created Location: <cn:playandcollectinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a1234</callsessionidentifier> <clientcorrelator>312345</clientcorrelator> <resourceurl> ourceurl> </cn:playandcollectinteractionsubscription> 9.5. DELETE powinien odpowiedzieć Allow:GET, POST.

22 10. Zasoby związane z indywidualną subskrypcją dotyczącą usługi Play- And- Collect Media Interaction Notifications Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu PlayAndCollectMediaInteractionNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać subscriptionid Identyfikator subskrypcji GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu PlayAndCollectmediaInteractionNotifications. GET /exampleapi/1/callnotification/subscriptions/collection/sub001 HTTP/1.1

23 HTTP/ OK <cn:playandcollectinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a1234</callsessionidentifier> <clientcorrelator>312345</clientcorrelator> <resourceurl> ourceurl> </cn:playandcollectinteractionsubscription> PUT powinien odpowiedzieć Allow:GET, DELETE POST powinien odpowiedzieć Allow:GET, DELETE DELETE Operacja ta jest użyta w celu anulowania subskrypcji i zatrzymania usługi. HTTP/ No Content HTTP/ No Content

24 11. Zasoby związane z subskrypcją dotyczącą usługi Play- And- Record Media Interaction Notifications Użyty zasób to: Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu PlayAndRecordMediaInteractionNotifications Zmienne żądania URI Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu PlayAndRecordMediaInteractionNotifications. GET /exampleapi/1/callnotification/subscriptions/recording HTTP/1.1

25 HTTP/ OK <cn:callnotificationsubscriptionlist xmlns:cn="urn:oma:xml:rest:callnotification:1"> <playandrecordinteractionsubscription> <notifyurl> <callsessionidentifier>a5678</callsessionidentifier> <clientcorrelator>412345</clientcorrelator> <resourceurl> ourceurl> </playandrecordinteractionsubscription> <resourceurl> RL> </cn:callnotificationsubscriptionlist> PUT powinien odpowiedzieć Allow:GET, POST POST POST /exampleapi/1/callnotification/subscriptions/recording HTTP/1.1 <cn:playandrecordinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a5678</callsessionidentifier> <clientcorrelator>412345</clientcorrelator> </cn:playandrecordinteractionsubscription>

26 HTTP/ Created Location: <cn:playandrecordinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a5678</callsessionidentifier> <clientcorrelator>412345</clientcorrelator> <resourceurl> ourceurl> </cn:playandrecordinteractionsubscription> DELETE powinien odpowiedzieć Allow:GET, POST. 12. Zasoby związane z indywidualną subskrypcją dotyczącą usługi Play- And- Record Media Interaction Notifications Użyty zasób to: Błąd! Nieprawidłowy odsyłacz typu hiperłącze.. Zasób ten jest użyty jako kontener dla wszystkich subskrypcji do usług informowania o zdarzeniach typu PlayAndRecordMediaInteractionNotifications Zmienne żądania URI

27 Nazwa serverroot apiversion Opis Podstawowy adres URL serwera: nazwahosta + port + podstawowascieżka Wersja ParlayREST API którą klient chce używać subscriptionid Identyfikator subskrypcji GET Operacja ta jest użyta do odczytania wszystkich subskrypcji do usługi informowania o zdarzeniach typu PlayAndRecordMediaInteractionNotifications. GET /exampleapi/1/callnotification/subscriptions/recording/sub001 HTTP/1.1 HTTP/ OK <cn:playandrecordinteractionsubscription xmlns:cn="urn:oma:xml:rest:callnotification:1"> <notifyurl> <callsessionidentifier>a5678</callsessionidentifier> <clientcorrelator>412345</clientcorrelator> <resourceurl> ourceurl> </cn:playandrecordinteractionsubscription>

28 12.3. PUT powinien odpowiedzieć Allow:GET, DELETE POST powinien odpowiedzieć Allow:GET, DELETE DELETE Operacja ta jest użyta w celu anulowania subskrypcji i zatrzymania usługi. DELETE /exampleapi/1/callnotification/subscriptions/recording/sub001 HTTP/1.1 HTTP/ No Content KONIEC DOKUMENTU