{"id":518,"date":"2021-07-30T14:50:25","date_gmt":"2021-07-30T14:50:25","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=518"},"modified":"2021-08-04T18:42:50","modified_gmt":"2021-08-04T18:42:50","slug":"notation-explained-3","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/direct-integration\/notation-explained-3\/","title":{"rendered":"Notation Explained"},"content":{"rendered":"

The message variables are primarily described using a hierarchical table \u2013 the hierarchy information is implied by the indentation amount of the first column. You can see the XML schema diagrams and example messages in the appendices. The table has 5 Columns:<\/p>\n

    \n
  1. \n

    Tag\/Attribute Name \u2013<\/span> this<\/span> contains<\/span> the name<\/span> of<\/span> the<\/span> tag<\/span> (or<\/span> the name<\/span> of<\/span> the attribute of<\/span> a tag)<\/span><\/span><\/p>\n<\/li>\n

  2. \n

    Data<\/span> Type<\/span> \u2013<\/span> this<\/span> gives<\/span> the<\/span> valid<\/span> data<\/span> type<\/span> that a tag<\/span> or<\/span> attribute<\/span> can<\/span> contain<\/span><\/span><\/p>\n<\/li>\n

  3. \n

    Max Length \u2013 this gives the maximum length for the contents of a tag or attribute. If a \u201c-\u201c is in this<\/span> column, then the tag or attribute has no max length, or it is a special type (like a Boolean for<\/span> example)<\/span><\/span><\/p>\n<\/li>\n

  4. \n

    Mandatory or Always present \u2013 for input messages, this is whether or not the tag or attribute is<\/span> required for a valid message & for output messages this is whether the tag or attribute will<\/span> always<\/span> be present in<\/span> the<\/span> message<\/span><\/span><\/p>\n<\/li>\n

  5. \n

    Comment \u2013 this gives a brief description of the function of the tag or attribute along with<\/span> anything<\/span> else<\/span> worth noting<\/span> in<\/span> relation<\/span> to<\/span> that<\/span> tag<\/span> or attribute<\/span><\/span><\/p>\n<\/li>\n<\/ol>\n

    Rows in orange are tags that do not have any content (i.e. they can have attributes, but they don\u2019t have<\/p>\n

    any content apart from child tags).<\/p>\n

    Rows in white are either tags that have content, or are attributes (marked so) of the containing tag.<\/p>\n\n\n\n\n\n\n\n
    \n

    Tag\/Attribute<\/span> Name<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Data<\/span> Type<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Max<\/span> Length<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Mandatory<\/span><\/span><\/p>\n

    or Always<\/span> Present<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Comments<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    RootTag<\/b><\/span> <\/b>(no<\/b><\/span> <\/b>attributes<\/b><\/span> <\/b>or<\/b><\/span> <\/b>content,<\/b><\/span> <\/b>only<\/b><\/span> <\/b>child<\/b><\/span> <\/b>tags)<\/b><\/span><\/span><\/p>\n<\/td>\n

    		<\/td>\n<\/td>\n<\/tr>\n
    <\/td>\n\n

    ChildTag<\/b><\/span> <\/b>(has<\/b><\/span> <\/b>no<\/b><\/span> <\/b>content)<\/b><\/span><\/span><\/p>\n<\/td>\n

    		<\/td>\n<\/td>\n<\/tr>\n
    <\/td>\n\n

    AnAttribute<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

    		<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
    <\/td>\n\n

    AnotherChildTag<\/span> (has<\/span> content)<\/span><\/span><\/p>\n<\/td>\n

    		<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    NOTE:<\/b> <\/b>The Mandatory\/Always Present fields take into account their scope in the XML hierarchy \u2013 if a tag is<\/p>\n

    labelled as Mandatory, then it is mandatory if its parent tag is present. The same applies to a tag\u2019s presence<\/p>\n

    in the response message.<\/p>\n

    This simple table would represent the simple XML message (not including the SOAP envelope or body):<\/p>\n

    <<\/span><\/span>RootTag<\/b><\/span><\/span>><\/span><\/span><\/span><\/span><\/p>\n

    <<\/span><\/span>ChildTag<\/b><\/span><\/span> <\/b>AnAttribute<\/b><\/span><\/span>=<\/b><\/span><\/span>“SomeValue”<\/span><\/span>><\/span><\/span><\/span><\/span><\/p>\n

    <<\/span><\/span>AnotherChildTag<\/b><\/span><\/span>><\/span><\/span>SomeValue<\/span><<\/span><\/span>\/<\/span>AnotherChildTag<\/b><\/span><\/span>><\/span><\/span><\/span><\/span><\/p>\n

    <<\/span><\/span>\/<\/span>ChildTag<\/b><\/span><\/span> <\/b>><\/span><\/span><\/span><\/span><\/p>\n

    <<\/span><\/span>\/<\/span>RootTag<\/b><\/span><\/span>><\/span><\/span><\/span><\/span><\/p>\n

    The possible values for the data types are detailed in the table below<\/p>\n\n\n\n\n\n\n\n
    \n

    Data<\/span><\/span><\/p>\n

    Type<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Description<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    N<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Numeric<\/span> \u2013<\/span> only<\/span> numbers<\/span> allowed<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    A<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Alpha<\/span> \u2013 any<\/span> printable character<\/span> is<\/span> allowed<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    B<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Boolean<\/span> \u2013<\/span> only TRUE<\/span> or FALSE<\/span> are<\/span> allowed<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    –<\/span><\/span><\/p>\n<\/td>\n

    		\n

    Special<\/span> types \u2013<\/span> these<\/span> variables<\/span> only<\/span> allow<\/span> a<\/span> specific<\/span> set of<\/span> values.<\/span> Details<\/span> of<\/span> the<\/span> allowed<\/span><\/span><\/p>\n

    values<\/span> are given<\/span> in<\/span> the comments<\/span> section<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    <\/h1>\n","protected":false},"excerpt":{"rendered":"

    The message variables are primarily described using a hierarchical table \u2013 the hierarchy information is implied by the indentation amount of the first column. You can see the XML schema diagrams and example messages in the appendices. The table has 5 Columns: Tag\/Attribute Name \u2013 this contains the name of the tag (or the name…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[2,76],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/518"}],"collection":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/comments?post=518"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/518\/revisions"}],"predecessor-version":[{"id":519,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/518\/revisions\/519"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=518"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=518"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=518"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}