You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Messaging Service

Messaging Service

Create a new message for an user
    Resource: messages 

    URL: https://api-stage.bimplus.net/v2/messages

    Example: https://api-stage.bimplus.net/v2/messages

    JSON Structure: 

    Name

    Mandatory / Optional

    Type

    Description

    id

    will be ignored

    string

    Id of the message

    receiver

    mandatory

    object

    receiver user object (contains id & email)
    sender optional object sender user object (contains id & email)
    id mandatory string(guid) id of the user
    email mandatory string email id of the user

    source

    mandatory

    string

    Source of the message (eg: Import Service)

    topic

    mandatory

    string

    Topic of the message

    severity

    mandatory

    object

    Severity can be Info, Warning, Error

    returnCode

    mandatory

    string

    Readable return code
    timestamp will be ignored string Creation date of the message
    unread mandatory boolean Whether the message was unread
    additionalData optional string Extra info
    correlationId optional guid Id of the other related message
     POST
     Create a new message for an user.
    Headers 
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
    JSON 
    {
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}
    Status 
    Status: 201 Created

    Get the message list of the current user
      Resource: user/<user_id>/messages 

      URL: https://api-stage.bimplus.net/v2/user/<user_id>/messages

      Example: https://api-stage.bimplus.net/v2/user/123456789/messages

       GET
       Gets the message list of the current user
      Headers 
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
      Status 
      Status: 200 OK
      JSON 
      [
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

      Get the message list of all the users
        Resource: messages 

        URL: https://api-stage.bimplus.net/v2/user/messages

        Example: https://api-stage.bimplus.net/v2/messages

         GET
         Gets the message list of the current user
        Headers 
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
        Status 
        Status: 200 OK
        JSON 
        [
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer3@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

        Get information about a specified message
          Resource: messages 

          URL: https://api-stage.bimplus.net/v2/messages/<message_id>

          Example: https://api-stage.bimplus.net/v2/messages/<message_id>
           GET
           Get information about a specified message
          Headers 
          Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
          Status 
          Status: 200 OK
          JSON 
          {
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

          Delete the specified message
            Resource: messages/<message_id> 

            URL: https://api-stage.bimplus.net/v2/messages/<message_id>

            Example: https://api-stage.bimplus.net/v2/messages/<message_id>

             DELETE
             Delete the specified message.
            Headers 
            Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
            Status 
            Status: 200 OK

            Mark a message as "read"
              Resource: messages/<message_id>/markasread 

              URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread 

              Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

               POST
               Mark a message as read.
              Headers 
              Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
              Status 
              Status: 200 OK

              Filter the messages (eg: Get all the unread messages from a particular user)
                Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26....

                URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

                Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

                where "%26" is the escape character for "&"

                 GET
                 Get information about a specified message
                Headers 
                Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
                Status 
                Status: 200 OK
                JSON 
                [
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:17",
        "unread": true,
        "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "timestamp": "2014-04-08T08:54:41",
        "unread": true,
        "correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    },
    {
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser2@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:27",
        "unread": true,       
        "correlationId": null
    }
]
                • No labels

                Impressum

                Privacy Policy