Organisation APIs

Get Organisation Email Preferences

OVERVIEW

Overview

Get the Email Preferences of an organisation from Publisher

This API call is used to retrieve the email preferences of a particular organisation from the system. The organisation identifier is the organisation id.

Since v4.6

HTTP Request

GET  /api/2/organisations/<ID>/emailpreferences

 

URL Parameters
Parameter Description
ID The ID of the organisation 

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content.

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

HTTP Response

Success

HTTP response 200 with Organisation Email Preferences object

(Example below)

 

Error

See API Error messages

Example HTTP Request & Response

GET http://example.com/context/api/2/organisations/3/emailpreferenceshttp://example.com/context/api/2/organisations/3/emailpreferences

 

JSON Response

{

    "emailpreferences": {

        "organisation": 3,

        "frequency": "Daily",

        "metadatanodes": [

            {

                "node": "Countries",

                "metadata": [

                    "Algeria",

                    "Angola",

                    "Benin",

                    ....

                ]

            },

            {

                "node": "American States",

                "metadata": [

                    "Alabama",

                    "Alaska",

                    "Arizona",

                    ....

                ]

            }

        ],

        "modules": [

            {

                "name": "Publications",

                "preference": "Include"

            },

            {

                "name": "Events",

                "preference": "Off"

            }

        ],

        "alertservices": [

            {

                "name": "Email alert ABC",

                "preference": "On"

            },

            {

                "name": "Email alert XYZ",

                "preference": "Off"

            }

        ]

    }

}

 

XML Response

<emailpreferences>

    <organisationid>3</organisationid>

    <frequency>Daily</frequency>    

    <metadatanodes>

        <metadatanode>

            <node>Countries</node>

            <metadata>Algeria</metadata>

            <metadata>Angola</metadata>

            <metadata>Benin</metadata>

            <metadata>...</metadata>

        </metadatanode>

        <metadatanode>

            <node>American States</node>

            <metadata>Alabama</metadata>

            <metadata>Alaska</metadata>

            <metadata>Arizona</metadata>

            <metadata>...</metadata>

        </metadatanode>

    </metadatanodes>

    <modules>

        <module>

            <name>Publications</name>

            <preference>Include</preference>

        </module>

        <module>

            <name>Events</name>

            <preference>Off</preference>

        </module>

    </modules>

    <alertservices>

        <alertservice>

            <name>Email alert ABC</name>

            <preference>On</preference>

        </alertservice>

        <alertservice>

            <name>Email alert XYZ</name>

            <preference>Off</preference>

        </alertservice>

    </alertservices>

</emailpreferences>

 

Comments


0 Comments

Last Updated: Nov 08,2024