Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Contents

Table of Content Zone
minLevel1
maxLevel7
locationtop

User payload details

This is a reference for the user payload fields you will see in the API documentation.

Field

Description

Example Value

id

JUNO’S unique User ID used for API updates.

123

first_name

User's legal first name

John

last_name

User's legal last name

McLane

designation

Default dimension ID: 12
Learn more about dimensions

Lt.

title

Default dimension ID: 18

Detective

job_type

Default dimension ID: 11

law enforcement

company

User's organization they belong to.

Nakatomi

email

Users must have a unique email address in JUNO.

jmclane@diehard.com

phone

Default dimension ID: 5

123-555-3214

address

Default dimension ID: 10

2121 Avenue of the Stars

city

Default dimension ID: 13

Los Angeles

state_province

Default dimension ID: 14

CA

postal_code

Default dimension ID: 15

90067

country

Default dimension ID: 16

United States of America

timezone

The users time zone.

-25200

avatar

Image set on the User's profile.

https://nakatomiplaza.com/avatar.png

points

Continuing education points earned from a user's activity. (CE)

120

account_level

JUNO admin level access.

0 = limited User access

99 = Full administrative access

0 or 99

client_guid

Alternate Client ID

735992af-c8a2-4cac-9072-5f1a29437e98

client_id

Can be used for the unique system user IDs.

A125637

banned

Determines if a user has restricted site access.

True or False

instagram

Default dimension ID: 1

https://www.instagram.com/myname

facebook

Default dimension ID: 2

https://www.facebook.com/myname

twitter

Default dimension ID: 3

https://twitter.com/myname

linkedin

Default dimension ID: 8

https://www.linkedin.com/in/myname/

username

Typically used for custom SSO integrations.

jmclane

website

Default dimension ID: 4

https://nakatomitower.com

date_created

Date and time a user was initially created in the JUNO database.

2022-11-03T21

date_last_login

A time stamp of the most recent user login.

1900-01-01T00

date_updated

A time stamp of the most recent user data update.

2021-07-29T15

Example JSON User payload:

Code Block
languagejson
{
    "id": 123,
    "first_name": "John",
    "last_name": "McLane",
    "designation": "Lt",
    "title": "Detective,"
    "job_type": "law enforcement",
    "company": "Nakatomi",
    "email": "jmclane@diehard.com",
    "phone": "123-555-4321",
    "address": "2121 Avenue of the Stars",
    "city": "Los Angeles",
    "state_province": "CA",
    "postal_code": "90067",
    "country": "United States of America",
    "timezone": -25200,
    "avatar": "https://nakatomiplaza.com/avatar.png",
    "points": 120,
    "account_level": 99,
    "client_id": A125637,
    "client_guid": "735992af-c8a2-4cac-9072-5f1a29437e98",
    "banned": "false",
    "username": "jmclane",
    "website": "https://junolive.co",
    "linkedin": "https://www.linkedin.com/in/jmclane/",
    "twitter": "https://twitter.com/jmclanenypd",
    "facebook": "https://www.facebook.com/john.mclane",
    "instagram": "https://www.instagram.com/jmclane/",
    "date_created": "1900-01-01T00:00:00",
    "date_last_login": "1900-01-01T00:00:00",
    "date_updated": "1900-01-01T00:00:00",
    "tags": [
      {
        "id": "1",
        "name": "Main Stage",
        "type": "2",
        "type_name": "Access Level",
        "score": "35"
      }
    ],
    "dimensions": [
      {
        "id": 14,
        "name": "Medical School",
        "value": "University of Washington"
      }
    ]
  }

Continuing Education (CE) API definitions

This is a reference for the CE fields you will see in the API documentation.

ce_credits: The maximum number of credits/hours a User can potentially earn for a CE.

ce_threshold: The % (0-100) amount of credits/hours a User must complete in order to claim a CE.

ce_status:

  • None = Hides the CE record from the User’s CE dashboard in their profile.

  • Open = The CE is available for the User to earn.

  • Ready = The CE is in the "ready to claim" state and displays a "claim" button in the user interface.

  • Done = The CE has been claimed by the User.

ce_earned_hours: The amount of credits/hours a User has earned towards the completion of the CE.

ce_claimed_hours: The amount of credits/hours a User has officially claimed for the completion of the CE.