docs/offeredapis/listener/documentation.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.6.1">
   8 <title>API Listener</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10 <style>
  11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12 /* Remove comment around @import statement below when using as a custom stylesheet */
  13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15 audio,canvas,video{display:inline-block}
  16 audio:not([controls]){display:none;height:0}
  17 [hidden],template{display:none}
  18 script{display:none!important}
  19 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  20 a{background:transparent}
  21 a:focus{outline:thin dotted}
  22 a:active,a:hover{outline:0}
  23 h1{font-size:2em;margin:.67em 0}
  24 abbr[title]{border-bottom:1px dotted}
  25 b,strong{font-weight:bold}
  26 dfn{font-style:italic}
  27 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  28 mark{background:#ff0;color:#000}
  29 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  30 pre{white-space:pre-wrap}
  31 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  32 small{font-size:80%}
  33 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  34 sup{top:-.5em}
  35 sub{bottom:-.25em}
  36 img{border:0}
  37 svg:not(:root){overflow:hidden}
  38 figure{margin:0}
  39 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  40 legend{border:0;padding:0}
  41 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  42 button,input{line-height:normal}
  43 button,select{text-transform:none}
  44 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  45 button[disabled],html input[disabled]{cursor:default}
  46 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  47 input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  48 input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  49 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  50 textarea{overflow:auto;vertical-align:top}
  51 table{border-collapse:collapse;border-spacing:0}
  52 *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  53 html,body{font-size:100%}
  54 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  55 a:hover{cursor:pointer}
  56 img,object,embed{max-width:100%;height:auto}
  57 object,embed{height:100%}
  58 img{-ms-interpolation-mode:bicubic}
  59 .left{float:left!important}
  60 .right{float:right!important}
  61 .text-left{text-align:left!important}
  62 .text-right{text-align:right!important}
  63 .text-center{text-align:center!important}
  64 .text-justify{text-align:justify!important}
  65 .hide{display:none}
  66 img,object,svg{display:inline-block;vertical-align:middle}
  67 textarea{height:auto;min-height:50px}
  68 select{width:100%}
  69 .center{margin-left:auto;margin-right:auto}
  70 .spread{width:100%}
  71 p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  72 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  73 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  74 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  75 a:hover,a:focus{color:#1d4b8f}
  76 a img{border:none}
  77 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  78 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  79 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  80 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  81 h1{font-size:2.125em}
  82 h2{font-size:1.6875em}
  83 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  84 h4,h5{font-size:1.125em}
  85 h6{font-size:1em}
  86 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  87 em,i{font-style:italic;line-height:inherit}
  88 strong,b{font-weight:bold;line-height:inherit}
  89 small{font-size:60%;line-height:inherit}
  90 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  91 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  92 ul,ol{margin-left:1.5em}
  93 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  94 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  95 ul.square{list-style-type:square}
  96 ul.circle{list-style-type:circle}
  97 ul.disc{list-style-type:disc}
  98 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  99 dl dt{margin-bottom:.3125em;font-weight:bold}
 100 dl dd{margin-bottom:1.25em}
 101 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
 102 abbr{text-transform:none}
 103 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 104 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
 105 blockquote cite:before{content:"\2014 \0020"}
 106 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 107 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 108 @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 109 h1{font-size:2.75em}
 110 h2{font-size:2.3125em}
 111 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 112 h4{font-size:1.4375em}}
 113 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
 114 table thead,table tfoot{background:#f7f8f7;font-weight:bold}
 115 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 116 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 117 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
 118 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
 119 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 120 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 121 .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
 122 .clearfix:after,.float-group:after{clear:both}
 123 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
 124 *:not(pre)>code.nobreak{word-wrap:normal}
 125 *:not(pre)>code.nowrap{white-space:nowrap}
 126 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
 127 em em{font-style:normal}
 128 strong strong{font-weight:400}
 129 .keyseq{color:rgba(51,51,51,.8)}
 130 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 131 .keyseq kbd:first-child{margin-left:0}
 132 .keyseq kbd:last-child{margin-right:0}
 133 .menuseq,.menuref{color:#000}
 134 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 135 .menuseq{word-spacing:-.02em}
 136 .menuseq b.caret{font-size:1.25em;line-height:.8}
 137 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 138 b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
 139 b.button:before{content:"[";padding:0 3px 0 2px}
 140 b.button:after{content:"]";padding:0 2px 0 3px}
 141 p a>code:hover{color:rgba(0,0,0,.9)}
 142 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 143 #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
 144 #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
 145 #content{margin-top:1.25em}
 146 #content:before{content:none}
 147 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 148 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
 149 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
 150 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
 151 #header .details span:first-child{margin-left:-.125em}
 152 #header .details span.email a{color:rgba(0,0,0,.85)}
 153 #header .details br{display:none}
 154 #header .details br+span:before{content:"\00a0\2013\00a0"}
 155 #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 156 #header .details br+span#revremark:before{content:"\00a0|\00a0"}
 157 #header #revnumber{text-transform:capitalize}
 158 #header #revnumber:after{content:"\00a0"}
 159 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 160 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
 161 #toc>ul{margin-left:.125em}
 162 #toc ul.sectlevel0>li>a{font-style:italic}
 163 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 164 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 165 #toc li{line-height:1.3334;margin-top:.3334em}
 166 #toc a{text-decoration:none}
 167 #toc a:active{text-decoration:underline}
 168 #toctitle{color:#7a2518;font-size:1.2em}
 169 @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
 170 body.toc2{padding-left:15em;padding-right:0}
 171 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 172 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 173 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 174 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 175 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 176 body.toc2.toc-right{padding-left:0;padding-right:15em}
 177 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
 178 @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 179 #toc.toc2{width:20em}
 180 #toc.toc2 #toctitle{font-size:1.375em}
 181 #toc.toc2>ul{font-size:.95em}
 182 #toc.toc2 ul ul{padding-left:1.25em}
 183 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 184 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 185 #content #toc>:first-child{margin-top:0}
 186 #content #toc>:last-child{margin-bottom:0}
 187 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
 188 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
 189 .sect1{padding-bottom:.625em}
 190 @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
 191 .sect1+.sect1{border-top:1px solid #efefed}
 192 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 193 #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 194 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 195 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 196 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 197 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 198 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 199 table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
 200 .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
 201 table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
 202 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 203 .admonitionblock>table td.icon{text-align:center;width:80px}
 204 .admonitionblock>table td.icon img{max-width:initial}
 205 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 206 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
 207 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 208 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
 209 .exampleblock>.content>:first-child{margin-top:0}
 210 .exampleblock>.content>:last-child{margin-bottom:0}
 211 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 212 .sidebarblock>:first-child{margin-top:0}
 213 .sidebarblock>:last-child{margin-bottom:0}
 214 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 215 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 216 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
 217 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
 218 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
 219 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
 220 @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
 221 @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
 222 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
 223 .listingblock pre.highlightjs{padding:0}
 224 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
 225 .listingblock pre.prettyprint{border-width:0}
 226 .listingblock>.content{position:relative}
 227 .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
 228 .listingblock:hover code[data-lang]:before{display:block}
 229 .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
 230 .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
 231 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 232 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
 233 table.pyhltable td.code{padding-left:.75em;padding-right:0}
 234 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
 235 pre.pygments .lineno{display:inline-block;margin-right:.25em}
 236 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
 237 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 238 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
 239 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 240 .quoteblock blockquote{margin:0;padding:0;border:0}
 241 .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 242 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 243 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
 244 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
 245 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
 246 .quoteblock .quoteblock blockquote:before{display:none}
 247 .verseblock{margin:0 1em 1.25em 1em}
 248 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 249 .verseblock pre strong{font-weight:400}
 250 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 251 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 252 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 253 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 254 .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
 255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
 256 .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
 257 table.tableblock{max-width:100%;border-collapse:separate}
 258 table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
 259 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 260 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
 261 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
 262 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
 263 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0}
 264 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0}
 265 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
 266 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
 267 table.frame-all{border-width:1px}
 268 table.frame-sides{border-width:0 1px}
 269 table.frame-topbot{border-width:1px 0}
 270 th.halign-left,td.halign-left{text-align:left}
 271 th.halign-right,td.halign-right{text-align:right}
 272 th.halign-center,td.halign-center{text-align:center}
 273 th.valign-top,td.valign-top{vertical-align:top}
 274 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 275 th.valign-middle,td.valign-middle{vertical-align:middle}
 276 table thead th,table tfoot th{font-weight:bold}
 277 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
 278 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 279 p.tableblock>code:only-child{background:none;padding:0}
 280 p.tableblock{font-size:1em}
 281 td>div.verse{white-space:pre}
 282 ol{margin-left:1.75em}
 283 ul li ol{margin-left:1.5em}
 284 dl dd{margin-left:1.125em}
 285 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 286 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 287 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 288 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 289 ul.unstyled,ol.unstyled{margin-left:0}
 290 ul.checklist{margin-left:.625em}
 291 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 292 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
 293 ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
 294 ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
 295 ul.inline>li>*{display:block}
 296 .unstyled dl dt{font-weight:400;font-style:normal}
 297 ol.arabic{list-style-type:decimal}
 298 ol.decimal{list-style-type:decimal-leading-zero}
 299 ol.loweralpha{list-style-type:lower-alpha}
 300 ol.upperalpha{list-style-type:upper-alpha}
 301 ol.lowerroman{list-style-type:lower-roman}
 302 ol.upperroman{list-style-type:upper-roman}
 303 ol.lowergreek{list-style-type:lower-greek}
 304 .hdlist>table,.colist>table{border:0;background:none}
 305 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 306 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 307 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 308 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 309 .colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top}
 310 .colist>table tr>td:first-of-type img{max-width:initial}
 311 .colist>table tr>td:last-of-type{padding:.25em 0}
 312 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
 313 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
 314 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
 315 .imageblock>.title{margin-bottom:0}
 316 .imageblock.thumb,.imageblock.th{border-width:6px}
 317 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 318 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 319 .image.left{margin-right:.625em}
 320 .image.right{margin-left:.625em}
 321 a.image{text-decoration:none;display:inline-block}
 322 a.image object{pointer-events:none}
 323 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 324 sup.footnote a,sup.footnoteref a{text-decoration:none}
 325 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 326 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 327 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
 328 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
 329 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
 330 #footnotes .footnote:last-of-type{margin-bottom:0}
 331 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 332 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
 333 .gist .file-data>table td.line-data{width:99%}
 334 div.unbreakable{page-break-inside:avoid}
 335 .big{font-size:larger}
 336 .small{font-size:smaller}
 337 .underline{text-decoration:underline}
 338 .overline{text-decoration:overline}
 339 .line-through{text-decoration:line-through}
 340 .aqua{color:#00bfbf}
 341 .aqua-background{background-color:#00fafa}
 342 .black{color:#000}
 343 .black-background{background-color:#000}
 344 .blue{color:#0000bf}
 345 .blue-background{background-color:#0000fa}
 346 .fuchsia{color:#bf00bf}
 347 .fuchsia-background{background-color:#fa00fa}
 348 .gray{color:#606060}
 349 .gray-background{background-color:#7d7d7d}
 350 .green{color:#006000}
 351 .green-background{background-color:#007d00}
 352 .lime{color:#00bf00}
 353 .lime-background{background-color:#00fa00}
 354 .maroon{color:#600000}
 355 .maroon-background{background-color:#7d0000}
 356 .navy{color:#000060}
 357 .navy-background{background-color:#00007d}
 358 .olive{color:#606000}
 359 .olive-background{background-color:#7d7d00}
 360 .purple{color:#600060}
 361 .purple-background{background-color:#7d007d}
 362 .red{color:#bf0000}
 363 .red-background{background-color:#fa0000}
 364 .silver{color:#909090}
 365 .silver-background{background-color:#bcbcbc}
 366 .teal{color:#006060}
 367 .teal-background{background-color:#007d7d}
 368 .white{color:#bfbfbf}
 369 .white-background{background-color:#fafafa}
 370 .yellow{color:#bfbf00}
 371 .yellow-background{background-color:#fafa00}
 372 span.icon>.fa{cursor:default}
 373 a span.icon>.fa{cursor:inherit}
 374 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 375 .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
 376 .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 377 .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
 378 .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
 379 .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
 380 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 381 .conum[data-value] *{color:#fff!important}
 382 .conum[data-value]+b{display:none}
 383 .conum[data-value]:after{content:attr(data-value)}
 384 pre .conum[data-value]{position:relative;top:-.125em}
 385 b.conum *{color:inherit!important}
 386 .conum:not([data-value]):empty{display:none}
 387 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 388 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
 389 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 390 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
 391 p{margin-bottom:1.25rem}
 392 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 393 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 394 .print-only{display:none!important}
 395 @media print{@page{margin:1.25cm .75cm}
 396 *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
 397 a{color:inherit!important;text-decoration:underline!important}
 398 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 399 a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 400 abbr[title]:after{content:" (" attr(title) ")"}
 401 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 402 thead{display:table-header-group}
 403 svg{max-width:100%}
 404 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 405 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 406 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 407 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
 408 .sect1{padding-bottom:0!important}
 409 .sect1+.sect1{border:0!important}
 410 #header>h1:first-child{margin-top:1.25rem}
 411 body.book #header{text-align:center}
 412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
 413 body.book #header .details{border:0!important;display:block;padding:0!important}
 414 body.book #header .details span:first-child{margin-left:0!important}
 415 body.book #header .details br{display:block}
 416 body.book #header .details br+span:before{content:none!important}
 417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 419 .listingblock code[data-lang]:before{display:block}
 420 #footer{background:none!important;padding:0 .9375em}
 421 #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
 422 .hide-on-print{display:none!important}
 423 .print-only{display:block!important}
 424 .hide-for-print{display:none!important}
 425 .show-for-print{display:inherit!important}}
 426 </style>
 427 </head>
 428 <body class="article toc2 toc-left">
 429 <div id="header">
 430 <h1>API Listener</h1>
 431 <div id="toc" class="toc2">
 432 <div id="toctitle">Table of Contents</div>
 433 <ul class="sectlevel1">
 434 <li><a href="#_overview">Overview</a>
 435 <ul class="sectlevel2">
 436 <li><a href="#_api_url">Api URL</a></li>
 437 <li><a href="#_version_information">Version information</a></li>
 438 <li><a href="#_uri_scheme">URI scheme</a></li>
 439 <li><a href="#_tags">Tags</a></li>
 440 <li><a href="#_produces">Produces</a></li>
 441 </ul>
 442 </li>
 443 <li><a href="#_paths">Resources</a>
 444 <ul class="sectlevel2">
 445 <li><a href="#_listener_resource">Listener</a></li>
 446 </ul>
 447 </li>
 448 <li><a href="#_definitions">Definitions</a>
 449 <ul class="sectlevel2">
 450 <li><a href="#_errorrepresentation">ErrorRepresentation</a></li>
 451 <li><a href="#_eventtype">EventType</a></li>
 452 <li><a href="#_listener">Listener</a></li>
 453 </ul>
 454 </li>
 455 </ul>
 456 </div>
 457 </div>
 458 <div id="content">
 459 <div class="sect1">
 460 <h2 id="_overview">Overview</h2>
 461 <div class="sectionbody">
 462 <div class="sect2">
 463 <h3 id="_api_url">Api URL</h3>
 464 <div class="paragraph">
 465 <p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/swagger.json">Swagger UI</a></p>
 466 </div>
 467 <div class="paragraph">
 468 <p><a href="https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&amp;src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&amp;noCache=7322.0">plant UML UI</a></p>
 469 </div>
 470 <div class="paragraph">
 471 <p>Listener API has to be implemented on the client side in order to receive notification.
 472 Notification are received if HUB has been posted on server side.</p>
 473 </div>
 474 </div>
 475 <div class="sect2">
 476 <h3 id="_version_information">Version information</h3>
 477 <div class="paragraph">
 478 <p><em>Version</em> : 0.1.0_inProgress</p>
 479 </div>
 480 </div>
 481 <div class="sect2">
 482 <h3 id="_uri_scheme">URI scheme</h3>
 483 <div class="paragraph">
 484 <p><em>Host</em> : serverRoot<br>
 485 <em>BasePath</em> : /externalapi/listener/v1<br>
 486 <em>Schemes</em> : HTTPS</p>
 487 </div>
 488 </div>
 489 <div class="sect2">
 490 <h3 id="_tags">Tags</h3>
 491 <div class="ulist">
 492 <ul>
 493 <li>
 494 <p>Listener</p>
 495 </li>
 496 </ul>
 497 </div>
 498 </div>
 499 <div class="sect2">
 500 <h3 id="_produces">Produces</h3>
 501 <div class="ulist">
 502 <ul>
 503 <li>
 504 <p><code>application/json;charset=utf-8</code></p>
 505 </li>
 506 </ul>
 507 </div>
 508 </div>
 509 </div>
 510 </div>
 511 <div class="sect1">
 512 <h2 id="_paths">Resources</h2>
 513 <div class="sectionbody">
 514 <div class="sect2">
 515 <h3 id="_listener_resource">Listener</h3>
 516 <div class="sect3">
 517 <h4 id="_listenercreate">createEvent</h4>
 518 <div class="literalblock">
 519 <div class="content">
 520 <pre>POST /listener</pre>
 521 </div>
 522 </div>
 523 <div class="sect4">
 524 <h5 id="_description">Description</h5>
 525 <div class="paragraph">
 526 <p>The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification</p>
 527 </div>
 528 <div class="paragraph">
 529 <p>Specific business errors for current operation will be encapsulated in</p>
 530 </div>
 531 <div class="paragraph">
 532 <p>HTTP Response 422 Unprocessable entity</p>
 533 </div>
 534 </div>
 535 <div class="sect4">
 536 <h5 id="_parameters">Parameters</h5>
 537 <table class="tableblock frame-all grid-all spread">
 538 <colgroup>
 539 <col style="width: 22.2222%;">
 540 <col style="width: 33.3333%;">
 541 <col style="width: 44.4445%;">
 542 </colgroup>
 543 <thead>
 544 <tr>
 545 <th class="tableblock halign-left valign-middle">Type</th>
 546 <th class="tableblock halign-left valign-middle">Name</th>
 547 <th class="tableblock halign-left valign-middle">Schema</th>
 548 </tr>
 549 </thead>
 550 <tbody>
 551 <tr>
 552 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
 553 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
 554 <em>required</em></p></td>
 555 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_listener">Listener</a></p></td>
 556 </tr>
 557 </tbody>
 558 </table>
 559 </div>
 560 <div class="sect4">
 561 <h5 id="_responses">Responses</h5>
 562 <table class="tableblock frame-all grid-all spread">
 563 <colgroup>
 564 <col style="width: 10%;">
 565 <col style="width: 70%;">
 566 <col style="width: 20%;">
 567 </colgroup>
 568 <thead>
 569 <tr>
 570 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 571 <th class="tableblock halign-left valign-middle">Description</th>
 572 <th class="tableblock halign-left valign-middle">Schema</th>
 573 </tr>
 574 </thead>
 575 <tbody>
 576 <tr>
 577 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</strong></p></td>
 578 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 579 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_listener">Listener</a></p></td>
 580 </tr>
 581 <tr>
 582 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 583 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 584 <p class="tableblock">List of supported error codes:
 585 - 20: Invalid URL parameter value
 586 - 21: Missing body
 587 - 22: Invalid body
 588 - 23: Missing body field
 589 - 24: Invalid body field
 590 - 25: Missing header
 591 - 26: Invalid header value
 592 - 27: Missing query-string parameter
 593 - 28: Invalid query-string parameter value</p></td>
 594 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 595 </tr>
 596 <tr>
 597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 598 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 599 <p class="tableblock">List of supported error codes:
 600 - 40: Missing credentials
 601 - 41: Invalid credentials
 602 - 42: Expired credentials</p></td>
 603 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 604 </tr>
 605 <tr>
 606 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 607 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 608 <p class="tableblock">List of supported error codes:
 609 - 50: Access denied
 610 - 51: Forbidden requester
 611 - 52: Forbidden user
 612 - 53: Too many requests</p></td>
 613 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 614 </tr>
 615 <tr>
 616 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 617 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 618 <p class="tableblock">Functional error</p></td>
 619 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 620 </tr>
 621 <tr>
 622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 623 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 624 <p class="tableblock">List of supported error codes:
 625 - 1: Internal error</p></td>
 626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 627 </tr>
 628 <tr>
 629 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 630 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 631 <p class="tableblock">List of supported error codes:
 632 - 5: The service is temporarily unavailable
 633 - 6: Orange API is over capacity, retry later !</p></td>
 634 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 635 </tr>
 636 </tbody>
 637 </table>
 638 </div>
 639 <div class="sect4">
 640 <h5 id="_consumes">Consumes</h5>
 641 <div class="ulist">
 642 <ul>
 643 <li>
 644 <p><code>application/json;charset=utf-8</code></p>
 645 </li>
 646 </ul>
 647 </div>
 648 </div>
 649 <div class="sect4">
 650 <h5 id="_produces_2">Produces</h5>
 651 <div class="ulist">
 652 <ul>
 653 <li>
 654 <p><code>application/json;charset=utf-8</code></p>
 655 </li>
 656 </ul>
 657 </div>
 658 </div>
 659 </div>
 660 </div>
 661 </div>
 662 </div>
 663 <div class="sect1">
 664 <h2 id="_definitions">Definitions</h2>
 665 <div class="sectionbody">
 666 <div class="sect2">
 667 <h3 id="_errorrepresentation">ErrorRepresentation</h3>
 668 <table class="tableblock frame-all grid-all spread">
 669 <colgroup>
 670 <col style="width: 42.8571%;">
 671 <col style="width: 57.1429%;">
 672 </colgroup>
 673 <thead>
 674 <tr>
 675 <th class="tableblock halign-left valign-middle">Name</th>
 676 <th class="tableblock halign-left valign-middle">Schema</th>
 677 </tr>
 678 </thead>
 679 <tbody>
 680 <tr>
 681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
 682 <em>optional</em></p></td>
 683 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 684 </tr>
 685 <tr>
 686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
 687 <em>optional</em></p></td>
 688 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 689 </tr>
 690 <tr>
 691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
 692 <em>required</em></p></td>
 693 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 694 </tr>
 695 <tr>
 696 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
 697 <em>optional</em></p></td>
 698 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 699 </tr>
 700 <tr>
 701 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br>
 702 <em>optional</em></p></td>
 703 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 704 </tr>
 705 <tr>
 706 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceError</strong><br>
 707 <em>optional</em></p></td>
 708 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 709 </tr>
 710 <tr>
 711 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
 712 <em>optional</em></p></td>
 713 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 714 </tr>
 715 </tbody>
 716 </table>
 717 </div>
 718 <div class="sect2">
 719 <h3 id="_eventtype">EventType</h3>
 720 <div class="paragraph">
 721 <p><em>Type</em> : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</p>
 722 </div>
 723 </div>
 724 <div class="sect2">
 725 <h3 id="_listener">Listener</h3>
 726 <div class="paragraph">
 727 <p>An event will be triggered for each time a notification is send to a listener.</p>
 728 </div>
 729 <table class="tableblock frame-all grid-all spread">
 730 <colgroup>
 731 <col style="width: 16.6666%;">
 732 <col style="width: 61.1111%;">
 733 <col style="width: 22.2223%;">
 734 </colgroup>
 735 <thead>
 736 <tr>
 737 <th class="tableblock halign-left valign-middle">Name</th>
 738 <th class="tableblock halign-left valign-middle">Description</th>
 739 <th class="tableblock halign-left valign-middle">Schema</th>
 740 </tr>
 741 </thead>
 742 <tbody>
 743 <tr>
 744 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
 745 <em>required</em></p></td>
 746 <td class="tableblock halign-left valign-middle"><p class="tableblock">An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.</p></td>
 747 <td class="tableblock halign-left valign-middle"><p class="tableblock">object</p></td>
 748 </tr>
 749 <tr>
 750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</strong><br>
 751 <em>required</em></p></td>
 752 <td class="tableblock halign-left valign-middle"></td>
 753 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
 754 </tr>
 755 <tr>
 756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</strong><br>
 757 <em>required</em></p></td>
 758 <td class="tableblock halign-left valign-middle"><p class="tableblock">id of the event</p></td>
 759 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 760 </tr>
 761 <tr>
 762 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventType</strong><br>
 763 <em>required</em></p></td>
 764 <td class="tableblock halign-left valign-middle"></td>
 765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_eventtype">EventType</a></p></td>
 766 </tr>
 767 </tbody>
 768 </table>
 769 </div>
 770 </div>
 771 </div>
 772 </div>
 773 <div id="footer">
 774 <div id="footer-text">
 775 Last updated 2018-09-12 13:46:31 +00:00
 776 </div>
 777 </div>
 778 </body>
 779 </html>