infoodle

Get some details from logged in user

GET /global/mysettings
OAuth2

Called after the user is authenticated to get some basic details

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • page_links object

      Additional properties are allowed.

      Hide page_links attribute Show page_links attribute object
      • myroster object

        Additional properties are allowed.

        Hide myroster attributes Show myroster attributes object
        • label string
        • url string
    • user object

      Additional properties are allowed.

      Hide user attributes Show user attributes object
      • houseid integer

        The houseid of the logged in user

      • image string

        A Base64 encoded string representing the individuals image on their profile

    • email object

      Default settings the user has chosen for their email

      Additional properties are allowed.

      Hide email attributes Show email attributes object
      • visible object

        Additional properties are allowed.

        Hide visible attribute Show visible attribute object
        • type string
      • mailtype object

        Additional properties are allowed.

        Hide mailtype attributes Show mailtype attributes object
        • mailtype_id integer
        • mailtype_name string
    • address object

      Lists the fields, order and properties of the address fields for entry. The output depends on the configuration and default country

      Additional properties are allowed.

      Hide address attributes Show address attributes object
      • streetaddress object

        Additional properties are allowed.

        Hide streetaddress attributes Show streetaddress attributes object
        • text string
        • mandatory integer
      • addressline2 object

        Additional properties are allowed.

        Hide addressline2 attribute Show addressline2 attribute object
        • text string
      • addressline3 object

        only supplied when line3&4 is enabled

        Additional properties are allowed.

        Hide addressline3 attribute Show addressline3 attribute object
        • text string
      • addressline4 object

        only supplied when line3&4 is enabled

        Additional properties are allowed.

        Hide addressline4 attribute Show addressline4 attribute object
        • text string
      • city object

        Additional properties are allowed.

        Hide city attribute Show city attribute object
        • text string
      • area object

        Additional properties are allowed.

        Hide area attribute Show area attribute object
        • text string
      • postalcode object

        Additional properties are allowed.

        Hide postalcode attribute Show postalcode attribute object
        • text string
GET /global/mysettings 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/global/mysettings' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "page_links": {
    "myroster": {
      "label": "My Roster",
      "url": "https://{sitecode}.infoodle.com/rosterresponse?roster=x1x1x1x1"
    }
  },
  "user": {
    "houseid": 5431,
    "image": "iVBORw0KGgoAAAANSUhEUgAAAMwAAAB6CAYAAAD....."
  },
  "email": {
    "visible": {
      "type": "anyone"
    },
    "mailtype": {
      "mailtype_id": 1,
      "mailtype_name": "General Communications"
    }
  },
  "address": {
    "streetaddress": {
      "text": "Street address",
      "mandatory": 1
    },
    "addressline2": {
      "text": "Address line 2"
    },
    "addressline3": {
      "text": "Address line 3"
    },
    "addressline4": {
      "text": "Address line 4"
    },
    "city": {
      "text": "Town/Suburb"
    },
    "area": {
      "text": "Province/State"
    },
    "postalcode": {
      "text": "Postal Code/Zipcode"
    }
  }
}