Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 2.78 KB

kudo.md

File metadata and controls

44 lines (36 loc) · 2.78 KB
Raw

Kudo

A Kudo is a simple gesture of thanks, praise, or endorsement from an Ohloh account to another person. An account may send Kudos to as many people as desired.

Kudos can be sent directly to another Ohloh account, or they may be sent to a contributor on a Project who does not have an Ohloh account. This flexibility makes Kudo records slightly complex.

When a Kudo is sent directly to an Ohloh Account, the recipient is identified by receiver_account_id.

When a Kudo is sent to a contributor on a Project who does not have an Account, the Kudo record contains both contributor_id and project_id, which together uniquely identify the recipient.

Ocassionally, an Ohloh Account holder may claim to be a Project contributor who has some existing Kudos. When this happens, the existing Kudos become linked to the Account, and the Kudos will now have all three properties: receiver_account_id, contributor_id, and project_id.

Properties

  • created_at The time at which this Kudo was sent.
  • sender_account_id The unique ID of the Account sending this Kudo.
  • sender_account_name The name of the Account sending this Kudo.
  • receiver_account_id If this Kudo can be linked to an Account, this is the unique ID of the Account receiving this Kudo. Otherwise, this element is omitted.
  • receiver_account_name If this kudo can be linked to an Account, this is the name of the Account receiving this Kudo. Otherwise, this element is omitted.
  • project_id If this Kudo was sent to a Project contributor instead of an Account, this is the unique ID of the Project. Otherwise, this element is omitted.
  • project_name If this Kudo was sent to a Project contributor instead of an Account, this is the Project name. Otherwise, this element is omitted.
  • contributor_id If this Kudo was sent to a Project contributor instead of an Account, this is the unique ID of the contributor. Otherwise, this element is omitted.
  • contributor_name If this Kudo was sent to a Project contributor instead of an account, this is the name which appears in the source control logs. Otherwise, this element is omitted.

Collection URL

To get a list of all Kudos received by an Account:

curl https://www.openhub.net/accounts/{account_id}/kudos.xml

To get a list of all Kudos sent by an Account:

curl https://www.openhub.net/accounts/{account_id}/kudos/sent.xml

These methods do not support any sorting, filtering, or paging options. You will always receive the complete list of all Kudos, sorted from new to old.

If you do not know the Account ID, you can also query for Kudos using the MD5 hash of the email address. Read more about email-based queries here.