Notification API

API change history

List of APIs related to Notification

Update motifications

  1. Update multiple notification read status information.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

notification to update

{
  "ids": [
    0
  ],
  "read": 0
}
{
  "description": "input wrapper to update notification status field",
  "required": [
    "ids",
    "read"
  ],
  "type": "object",
  "properties": {
    "ids": {
      "description": "identifier",
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    },
    "read": {
      "format": "int32",
      "description": "the read flag which determine whether the notification has been read by user.\r\n10: Unread\r\n11: Read",
      "maximum": 11,
      "minimum": 10,
      "type": "integer"
    }
  }
}
{
  "ids": [
    0
  ],
  "read": 0
}
{
  "description": "input wrapper to update notification status field",
  "required": [
    "ids",
    "read"
  ],
  "type": "object",
  "properties": {
    "ids": {
      "description": "identifier",
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    },
    "read": {
      "format": "int32",
      "description": "the read flag which determine whether the notification has been read by user.\r\n10: Unread\r\n11: Read",
      "maximum": 11,
      "minimum": 10,
      "type": "integer"
    }
  }
}
{
  "ids": [
    0
  ],
  "read": 0
}
{
  "description": "input wrapper to update notification status field",
  "required": [
    "ids",
    "read"
  ],
  "type": "object",
  "properties": {
    "ids": {
      "description": "identifier",
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    },
    "read": {
      "format": "int32",
      "description": "the read flag which determine whether the notification has been read by user.\r\n10: Unread\r\n11: Read",
      "maximum": 11,
      "minimum": 10,
      "type": "integer"
    }
  }
}
{
  "ids": [
    0
  ],
  "read": 0
}
{
  "description": "input wrapper to update notification status field",
  "required": [
    "ids",
    "read"
  ],
  "type": "object",
  "properties": {
    "ids": {
      "description": "identifier",
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    },
    "read": {
      "format": "int32",
      "description": "the read flag which determine whether the notification has been read by user.\r\n10: Unread\r\n11: Read",
      "maximum": 11,
      "minimum": 10,
      "type": "integer"
    }
  }
}

Responses

200 OK

Returns the notification updated record

Representations

{
  "type": "array",
  "items": {
    "description": "Represents a notification object.",
    "type": "object",
    "properties": {
      "id": {
        "format": "int64",
        "description": "Notification ID",
        "type": "integer"
      },
      "targetID": {
        "format": "uuid",
        "description": "TargetID of the resource/resource content the notification is associated with.",
        "type": "string"
      },
      "notifyGroupId": {
        "format": "uuid",
        "description": "Notification group ID.",
        "type": "string"
      },
      "type": {
        "description": "Resource/Resource Content Type",
        "type": "string"
      },
      "recordDate": {
        "format": "date-time",
        "description": "Notification recorded date.",
        "type": "string"
      },
      "notifyMessage": {
        "description": "Notification message.",
        "type": "string"
      },
      "notifyStatus": {
        "format": "int32",
        "description": "Notification status.\r\n10: Unread\r\n11: Read",
        "type": "integer"
      },
      "ancestor": {
        "description": "ancestor for the targetID.",
        "type": "array",
        "items": {
          "description": "Target which can be resource or resource content",
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "entity id",
              "type": "string"
            },
            "name": {
              "description": "entity name",
              "type": "string"
            },
            "typeID": {
              "description": "entity type",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "typeName": {
              "description": "entity type name",
              "type": "string"
            },
            "isResourceType": {
              "description": "whether the entity is a resource",
              "type": "boolean"
            }
          }
        }
      }
    }
  }
}
[
  {
    "id": 0,
    "targetID": "string",
    "notifyGroupId": "string",
    "type": "string",
    "recordDate": "string",
    "notifyMessage": "string",
    "notifyStatus": 0,
    "ancestor": [
      {
        "id": "string",
        "name": "string",
        "typeID": {},
        "typeName": "string",
        "isResourceType": true
      }
    ]
  }
]
{
  "type": "array",
  "items": {
    "description": "Represents a notification object.",
    "type": "object",
    "properties": {
      "id": {
        "format": "int64",
        "description": "Notification ID",
        "type": "integer"
      },
      "targetID": {
        "format": "uuid",
        "description": "TargetID of the resource/resource content the notification is associated with.",
        "type": "string"
      },
      "notifyGroupId": {
        "format": "uuid",
        "description": "Notification group ID.",
        "type": "string"
      },
      "type": {
        "description": "Resource/Resource Content Type",
        "type": "string"
      },
      "recordDate": {
        "format": "date-time",
        "description": "Notification recorded date.",
        "type": "string"
      },
      "notifyMessage": {
        "description": "Notification message.",
        "type": "string"
      },
      "notifyStatus": {
        "format": "int32",
        "description": "Notification status.\r\n10: Unread\r\n11: Read",
        "type": "integer"
      },
      "ancestor": {
        "description": "ancestor for the targetID.",
        "type": "array",
        "items": {
          "description": "Target which can be resource or resource content",
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "entity id",
              "type": "string"
            },
            "name": {
              "description": "entity name",
              "type": "string"
            },
            "typeID": {
              "description": "entity type",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "typeName": {
              "description": "entity type name",
              "type": "string"
            },
            "isResourceType": {
              "description": "whether the entity is a resource",
              "type": "boolean"
            }
          }
        }
      }
    }
  }
}
[
  {
    "id": 0,
    "targetID": "string",
    "notifyGroupId": "string",
    "type": "string",
    "recordDate": "string",
    "notifyMessage": "string",
    "notifyStatus": 0,
    "ancestor": [
      {
        "id": "string",
        "name": "string",
        "typeID": {},
        "typeName": "string",
        "isResourceType": true
      }
    ]
  }
]
{
  "type": "array",
  "items": {
    "description": "Represents a notification object.",
    "type": "object",
    "properties": {
      "id": {
        "format": "int64",
        "description": "Notification ID",
        "type": "integer"
      },
      "targetID": {
        "format": "uuid",
        "description": "TargetID of the resource/resource content the notification is associated with.",
        "type": "string"
      },
      "notifyGroupId": {
        "format": "uuid",
        "description": "Notification group ID.",
        "type": "string"
      },
      "type": {
        "description": "Resource/Resource Content Type",
        "type": "string"
      },
      "recordDate": {
        "format": "date-time",
        "description": "Notification recorded date.",
        "type": "string"
      },
      "notifyMessage": {
        "description": "Notification message.",
        "type": "string"
      },
      "notifyStatus": {
        "format": "int32",
        "description": "Notification status.\r\n10: Unread\r\n11: Read",
        "type": "integer"
      },
      "ancestor": {
        "description": "ancestor for the targetID.",
        "type": "array",
        "items": {
          "description": "Target which can be resource or resource content",
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "entity id",
              "type": "string"
            },
            "name": {
              "description": "entity name",
              "type": "string"
            },
            "typeID": {
              "description": "entity type",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "typeName": {
              "description": "entity type name",
              "type": "string"
            },
            "isResourceType": {
              "description": "whether the entity is a resource",
              "type": "boolean"
            }
          }
        }
      }
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

404 Not Found

The notification is not found

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X PUT "https://luminus.azure-api.net/notification/user/read"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://luminus.azure-api.net/notification/user/read?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/notification/user/read");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/notification/user/read?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/notification/user/read";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/notification/user/read');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("PUT", "/notification/user/read?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("PUT", "/notification/user/read?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/notification/user/read')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body