Core - Bulletin Board
==============================
.. Last update: 01/09/2020

Some documents and/or FAQs can be exposed, with translation, to the mobile User Agents for users
to browse and read.

These documents are typically hardcoded inside the mobile apps.

Access to these functions does not require a valid JWT ``Authorization`` header.

The base url for the APIs in this page is at::

  /api/mobile/

A JSON file with OpenAPI data about all core-related mobile APIs can be downloaded :download:`here </openapi/srv-core/api-src-WebMobile.json>`.


Get Terms and Condition document
--------------------------------

.. openapi:: /openapi/srv-core/api-src-WebMobile.json
   :paths:
     /v1/bb/terms/{lcid}/{cid}/{ordinal}

| lcid: int
| cid: Guid
| ordinal: int

If the document cannot be found a generic negative response is returned.

If the document is found, the response has this data::

  {
    Id: 9,                                  // Int
    CommunityId: 777,                       // Int
    CommunityName: "Community",             // String
    LastUpdated: "2001-01-01T01:01:01Z",    // DateTime
    LastUpdateBy: "User Name",              // String (nullable)
    Title: "Document",                      // String
    Body: "",                               // String (nullable)
    Url: "",                                // String (nullable)
    Ordinal: 1,                             // Int
    Type: 0,                                // Int
    AttachmentId: null,                     // Guid (nullable)
    LCID: 1033,                             // Int
    Language: "en-US"                       // String
  }

The document may be contained inside the ``Body`` property, or if ``URL`` is a valid URL it may
be available at that location. If the ``AttachmentId`` is set to a valid Guid, the document may
be available as an attachment with the given Guid.

The User Agent is expected to be able to deal with all types of documents.

The ``Type`` value can be one of the :ref:`enum-documenttype` enumeration.

Get FAQs
--------

.. openapi:: /openapi/srv-core/api-src-WebMobile.json
   :paths:
     /v1/bb/faqs/{lcid}/{cid}

If the FAQs cannot be found a generic negative response is returned.

If the FAQs are found, the response has this data::

  [
    {
      Id: 9,                                  // Int
      CommunityId: 777,	                      // Int
      CommunityName: "Community",             // String
      LastUpdated: "2001-01-01T01:01:01Z",    // DateTime
      LastUpdateBy: "User Name",              // String (nullable)
      Title: "Document",                      // String
      Body: "",	                              // String (nullable)
      Url: "",                                // String (nullable)
      Ordinal: 1,                             // Int
      Type: 0,                                // Int
      AttachmentId: null,                     // Guid (nullable)
      LCID: 1033,                             // Int
      Language: "en-US"                       // String
    },
    ...
  ]

The body of the FAQ may be contained inside the ``Body`` property, or if ``URL`` is a
valid URL it may be available at that location. If the ``AttachmentId`` is set to a
valid Guid, the FAQ entry may be available as an attachment with the given Guid.

The User Agent is expected to be able to deal with all types of documents, and sort them
by their ordinal value to present the intended list to the user.

The ``Type`` value can be one of the :ref:`enum-documenttype` enumeration.


Get Attachment
--------------

.. openapi:: /openapi/srv-core/api-src-WebMobile.json
   :paths:
     /v1/bb/attachment/{id}

The attachment can be downloaded via its Guid; the response contains an HTTP file download
with the correct file name and MIME type.

If the file cannot be found, a 404 Not Found is returned.