Company profile - Canadian Company Capabilities
Third-Party Information Liability Disclaimer
Some of the information on this Web page has been provided by external sources. The Government of Canada is not responsible for the accuracy, reliability or currency of the information supplied by external sources. Users wishing to rely upon this information should consult directly with the source of the information. Content provided by external sources is not subject to official languages, privacy and accessibility requirements.
Kahler Personal Injury Law Firm
Legal/Operating Name:
Kahler Personal Injury Law Firm
Alternate Name:
Kahler Personal Injury Lawyers
Mailing Address:
1800-5775 Yonge StNORTH YORK, Ontario
M2M 4J1
Location Address:
1800-5775 Yonge StNORTH YORK, Ontario
M2M 4J1
Tel.:<PHONE_NUMBER>
Fax:<PHONE_NUMBER>
Logo
Company Profile
Expert Toronto Car Accident Lawyers
The Kahler Personal Injury Law Firm is a leading Toronto personal injury law firm. We are a team of highly dedicated and experienced, successful Toronto personal injury lawyers. We only represent injury victims and their families.
The lawyers at the Kahler Personal Injury Law Firm have successfully argued and enforced the rights of injured people at all levels of court, including the Ontario Superior Court of Justice, the Divisional Court and the Ontario Court of Appeal.
We represent our clients with experience, dedication, respect and absolute professionalism. We know that each client faces a unique set of challenges. Our goal is to help them meet and overcome these challenges.
The Kahler Personal Injury Law Firm takes great pride in providing its clients with exceptional customer service from the first phone call up to and after resolving their personal injury claim.
We take time to get to know our clients, understand their unique situations and needs. We work as a team with our clients and are fully invested in protecting their rights and achieving the best results.
Full profile
Full profile
Contact information
Company description
Product / Service / Licensing
Many people have access to private long term disability benefits, often through group benefit plans offered by their employers. These benefits help to replace lost income when the insured person suffers a disability that prevents them from working.
The duty protects victims of slip and fall injuries, injuries resulting from fires, injuries occurring at amusements parks and other commercial establishments.
You may be entitled to claim compensation from the person responsible for the injury. This compensation is normally paid by the responsible persons insurer. In Ontario, slip and fall injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team has helped injury victims recover compensation from negligent property owners, department stores, amusement parks, hotel operators, building inspectors and government bodies responsible for keeping properties safe.
The death of a loved one is an intensely painful and personal event. Coming to terms with such a loss is made more difficult when the death is unexpected and preventable.
No amount of money can fill the void left by the loved one lost. However, family members will face real challenges paying for funeral expenses, grief counseling, replacing the deceaseds help caring for children, managing the household and paying bills with less income.
Our system of law requires those responsible for the death to compensate family members for these and other losses. Family members are entitled to claim compensation from the person responsible for the death. This compensation is normally paid by the at-fault persons insurer.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
In Ontario, motor vehicle collision victims and their family members can claim compensation for their losses from their own insurance company (No-Fault Accident Benefits) and from the person responsible for the collision (Tort Claim).
Your insurer is obliged to pay No-Fault Accident Benefits compensating for lost income and paying for help performing household maintenance and self care activities. It must also pay for all necessary medical services and rehabilitation. The benefits are payable upon application. Time limits govern when you must apply. Laws determine which benefits are payable. Insurers often deny benefits they are obliged to pay. You are entitled to dispute the insurers refusal to pay your benefits. Different levels of benefits are available to injury victims, depending upon the type of injury and impairments.
The process is complicated and requires analysis by an experienced personal injury lawyer.
You may also be entitled to claim compensation from the person responsible for the collision. This compensation is normally paid by the at-fault persons insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced Toronto personal injury lawyer.
Our team has helped injury victims recover compensation from at-fault drivers, motor vehicle owners, bars and taverns who over-served automobile operators and government bodies responsible for keeping roadways safe
In Ontario, snowmobile accident victims and their family members can claim compensation for their losses from their own insurance company (No-Fault Accident benefits) and from the person responsible for the collision (Tort claim).
Your insurer is obliged to pay No-Fault Accident Benefits compensating for lost income and paying for help performing household maintenance and self care activities. It must also pay for all necessary medical services and rehabilitation. The benefits are payable upon application. Time limits govern when you must apply. Laws determine which benefits are payable. Insurance companies often deny benefits they are obliged to pay. You are entitled to dispute the insurers refusal to pay your benefits. Different levels of benefits are available to snowmobile injury victims, depending upon the type of injury and impairments.
The process is complicated and requires analysis by an experienced personal injury lawyer.
You may also be entitled to claim compensation from the person responsible for the collision. This compensation is normally paid by the responsible persons insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team personal injury lawyers has helped injured people recover compensation from at-fault drivers, snowmobile owners, bars and taverns who over-served snowmobile operators and snowmobile trail operators responsible for keeping trails safe.
In Ontario, boating injury victims and their family members can recover compensation for their losses from the responsible boat operator and the boat owner. Regulations and boating laws are complicated and can restrict recovery for injury victims. Determining who is at fault and what damages you can recover requires expert legal analysis.
You may be entitled to claim compensation from the person responsible for the boating injury. This compensation is normally paid by the responsible boat operator and owners insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team has helped injured people recover compensation from at-fault boat owners, operators and from bars and taverns who over-served vehicle operators.
When we are unwell we place our trust and respect in the hands of our health care professionals. Most of the time our trust is well placed, however sometimes health care professionals make errors which cause us serious personal injury.
In Ontario, patients who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Determining whether you have suffered an injury resulting from medical malpractice, identifying those responsible and assessing the value of your claim requires analysis by an experienced personal injury lawyer.
The law holds owners responsible for injuries caused by their animals. These owners are liable to pay compensation for injuries and losses which the animal causes. Normally the owners homeowner or tenant insurance policy will pay the compensation. Animal owners are responsible for injuries caused by vicious animals who attack and for injuries caused by their failure to keep their livestock properly contained.
In Ontario, animal attack victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing your animal attack injury, identifying those responsible and determining the value of your claim requires analysis by an experienced personal injury lawyer.
We all depend on the safety of the products we use each day. We are entitled to expect that all things we use, including the cars we drive, the clothes we wear and the food we eat, are designed, tested, manufactured, produced and distributed in a way that protects us from harm.
Sometimes things go wrong. In Ontario, the law protects us from dangerous products. Consumers who suffer injury caused by a dangerous product can claim compensation from those responsible.
In Ontario, dangerous product injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Determining whether a product is unsafe, assessing whether it caused your injury, identifying those responsible and assessing the value of your claim requires analysis by an experienced personal injury lawyer.
Sector information
Key / Major clients:
Toronto Serious injury victims, Toronto Car accident victims, seriously injured persons,Third-Party Information Liability Disclaimer
Some of the information on this Web page has been provided by external sources. The Government of Canada is not responsible for the accuracy, reliability or currency of the information supplied by external sources. Users wishing to rely upon this information should consult directly with the source of the information. Content provided by external sources is not subject to official languages, privacy and accessibility requirements.
Contacts
Contact information
Description
Company description
Products, services and licensing
Product / Service / Licensing
Many people have access to private long term disability benefits, often through group benefit plans offered by their employers. These benefits help to replace lost income when the insured person suffers a disability that prevents them from working.
The duty protects victims of slip and fall injuries, injuries resulting from fires, injuries occurring at amusements parks and other commercial establishments.
You may be entitled to claim compensation from the person responsible for the injury. This compensation is normally paid by the responsible persons insurer. In Ontario, slip and fall injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team has helped injury victims recover compensation from negligent property owners, department stores, amusement parks, hotel operators, building inspectors and government bodies responsible for keeping properties safe.
The death of a loved one is an intensely painful and personal event. Coming to terms with such a loss is made more difficult when the death is unexpected and preventable.
No amount of money can fill the void left by the loved one lost. However, family members will face real challenges paying for funeral expenses, grief counseling, replacing the deceaseds help caring for children, managing the household and paying bills with less income.
Our system of law requires those responsible for the death to compensate family members for these and other losses. Family members are entitled to claim compensation from the person responsible for the death. This compensation is normally paid by the at-fault persons insurer.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
In Ontario, motor vehicle collision victims and their family members can claim compensation for their losses from their own insurance company (No-Fault Accident Benefits) and from the person responsible for the collision (Tort Claim).
Your insurer is obliged to pay No-Fault Accident Benefits compensating for lost income and paying for help performing household maintenance and self care activities. It must also pay for all necessary medical services and rehabilitation. The benefits are payable upon application. Time limits govern when you must apply. Laws determine which benefits are payable. Insurers often deny benefits they are obliged to pay. You are entitled to dispute the insurers refusal to pay your benefits. Different levels of benefits are available to injury victims, depending upon the type of injury and impairments.
The process is complicated and requires analysis by an experienced personal injury lawyer.
You may also be entitled to claim compensation from the person responsible for the collision. This compensation is normally paid by the at-fault persons insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced Toronto personal injury lawyer.
Our team has helped injury victims recover compensation from at-fault drivers, motor vehicle owners, bars and taverns who over-served automobile operators and government bodies responsible for keeping roadways safe
In Ontario, snowmobile accident victims and their family members can claim compensation for their losses from their own insurance company (No-Fault Accident benefits) and from the person responsible for the collision (Tort claim).
Your insurer is obliged to pay No-Fault Accident Benefits compensating for lost income and paying for help performing household maintenance and self care activities. It must also pay for all necessary medical services and rehabilitation. The benefits are payable upon application. Time limits govern when you must apply. Laws determine which benefits are payable. Insurance companies often deny benefits they are obliged to pay. You are entitled to dispute the insurers refusal to pay your benefits. Different levels of benefits are available to snowmobile injury victims, depending upon the type of injury and impairments.
The process is complicated and requires analysis by an experienced personal injury lawyer.
You may also be entitled to claim compensation from the person responsible for the collision. This compensation is normally paid by the responsible persons insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team personal injury lawyers has helped injured people recover compensation from at-fault drivers, snowmobile owners, bars and taverns who over-served snowmobile operators and snowmobile trail operators responsible for keeping trails safe.
In Ontario, boating injury victims and their family members can recover compensation for their losses from the responsible boat operator and the boat owner. Regulations and boating laws are complicated and can restrict recovery for injury victims. Determining who is at fault and what damages you can recover requires expert legal analysis.
You may be entitled to claim compensation from the person responsible for the boating injury. This compensation is normally paid by the responsible boat operator and owners insurer. In Ontario, injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing the value of your claim and determining responsibility requires analysis by an experienced personal injury lawyer.
Our team has helped injured people recover compensation from at-fault boat owners, operators and from bars and taverns who over-served vehicle operators.
When we are unwell we place our trust and respect in the hands of our health care professionals. Most of the time our trust is well placed, however sometimes health care professionals make errors which cause us serious personal injury.
In Ontario, patients who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Determining whether you have suffered an injury resulting from medical malpractice, identifying those responsible and assessing the value of your claim requires analysis by an experienced personal injury lawyer.
The law holds owners responsible for injuries caused by their animals. These owners are liable to pay compensation for injuries and losses which the animal causes. Normally the owners homeowner or tenant insurance policy will pay the compensation. Animal owners are responsible for injuries caused by vicious animals who attack and for injuries caused by their failure to keep their livestock properly contained.
In Ontario, animal attack victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Assessing your animal attack injury, identifying those responsible and determining the value of your claim requires analysis by an experienced personal injury lawyer.
We all depend on the safety of the products we use each day. We are entitled to expect that all things we use, including the cars we drive, the clothes we wear and the food we eat, are designed, tested, manufactured, produced and distributed in a way that protects us from harm.
Sometimes things go wrong. In Ontario, the law protects us from dangerous products. Consumers who suffer injury caused by a dangerous product can claim compensation from those responsible.
In Ontario, dangerous product injury victims who suffer serious and permanent injuries can recover damages compensating them for all of their losses, including their pain and suffering, their past and future lost income, their extraordinary future health care and home maintenance costs, and their out of pocket expenses.
Time limits govern when you must notify the responsible parties that you intend to bring a claim and they govern when you must start your claim for compensation. These time limits can restrict your rights to recover your losses. Not everyone is entitled to claim compensation from the person who caused the accident. Each claim is different. Determining whether a product is unsafe, assessing whether it caused your injury, identifying those responsible and assessing the value of your claim requires analysis by an experienced personal injury lawyer.


Inspection detects usages of pre-Java 8 Collection API methods which can be simplified using new Java 8 API.
The following cases are covered by this inspection:
Map.putIfAbsent method could be used to replace the code like this:
if (!map.containsKey(aKey)) {
map.put(aKey, aValue);
}
List.sort instance method could be used to replace Collections.sort static method


{% extends "body.html" %} {% block content %}
Welcome to {{name}}.
Follow the link below to confirm your email:
Once you have validated your account it will need to be also validated by the member of your organisation or {{name}} member. Thid usually takes less then 24h.
If you have any questions do not hesitate to contact us<EMAIL_ADDRESS>Yours sincerely,
The {{name}} team


SPLAIN
Section: Perl Programmers Reference Guide (1)Updated: 2012-06-22
Index Return to Main Contents
NAME
diagnostics, splain - produce verbose warning diagnosticsSYNOPSIS
Using the "diagnostics" pragma:
use diagnostics; use diagnostics -verbose; enable diagnostics; disable diagnostics;
Using the "splain" standalone filter program:
perl program 2>diag.out splain [-v] [-p] diag.out
Using diagnostics to get stack traces from a misbehaving script:
perl -Mdiagnostics=-traceonly my_script.pl
DESCRIPTION
The diagnostics Pragma
This module extends the terse diagnostics normally emitted by both the perl compiler and the perl interpreter (from running perl with a -w switch or "use warnings"), augmenting them with the more explicative and endearing descriptions found in perldiag. Like the other pragmata, it affects the compilation phase of your program rather than merely the execution phase.To use in your program as a pragma, merely invoke
use diagnostics;
at the start (or near the start) of your program. (Note that this does enable perl's -w flag.) Your whole compilation will then be subject(ed :-) to the enhanced diagnostics. These still go out STDERR.
Due to the interaction between runtime and compiletime issues, and because it's probably not a very good idea anyway, you may not use "no diagnostics" to turn them off at compiletime. However, you may control their behaviour at runtime using the disable() and enable() methods to turn them off and on respectively.
The -verbose flag first prints out the perldiag introduction before any other diagnostics. The $diagnostics::PRETTY variable can generate nicer escape sequences for pagers.
Warnings dispatched from perl itself (or more accurately, those that match descriptions found in perldiag) are only displayed once (no duplicate descriptions). User code generated warnings a la warn() are unaffected, allowing duplicate user messages to be displayed.
This module also adds a stack trace to the error message when perl dies. This is useful for pinpointing what caused the death. The -traceonly (or just -t) flag turns off the explanations of warning messages leaving just the stack traces.  By supplying the -warntrace (or just -w) flag, any warnings emitted will also come with a stack trace.
The splain Program
While apparently a whole nuther program, splain is actually nothing more than a link to the (executable) diagnostics.pm module, as well as a link to the diagnostics.pod documentation. The -v flag is like the "use diagnostics -verbose" directive. The -p flag is like the $diagnostics::PRETTY variable. Since you're post-processing with splain, there's no sense in being able to enable() or disable() processing.Output from splain is directed to STDOUT, unlike the pragma.
EXAMPLES
The following file is certain to trigger a few errors at both runtime and compiletime:
use diagnostics; print NOWHERE "nothing\n"; print STDERR "\n\tThis message should be unadorned.\n"; warn "\tThis is a user warning"; print "\nDIAGNOSTIC TESTER: Please enter a <CR> here: "; my $a, $b = scalar <STDIN>; print "\n"; print $x/$y;
If you prefer to run your program first and look at its problem afterwards, do this:
perl -w test.pl 2>test.out ./splain < test.out
Note that this is not in general possible in shells of more dubious heritage, as the theoretical
(perl -w test.pl >/dev/tty) >& test.out ./splain < test.out
Because you just moved the existing stdout to somewhere else.
If you don't want to modify your source code, but still have on-the-fly warnings, do this:
exec 3>&1; perl -w test.pl 2>&1 1>&3 3>&- | splain 1>&2 3>&-
Nifty, eh?
If you want to control warnings on the fly, do something like this. Make sure you do the "use" first, or you won't be able to get at the enable() or disable() methods.
use diagnostics; # checks entire compilation phase print "\ntime for 1st bogus diags: SQUAWKINGS\n"; print BOGUS1 'nada'; print "done with 1st bogus\n"; disable diagnostics; # only turns off runtime warnings print "\ntime for 2nd bogus: (squelched)\n"; print BOGUS2 'nada'; print "done with 2nd bogus\n"; enable diagnostics; # turns back on runtime warnings print "\ntime for 3rd bogus: SQUAWKINGS\n"; print BOGUS3 'nada'; print "done with 3rd bogus\n"; disable diagnostics; print "\ntime for 4th bogus: (squelched)\n"; print BOGUS4 'nada'; print "done with 4th bogus\n";
INTERNALS
Diagnostic messages derive from the perldiag.pod file when available at runtime. Otherwise, they may be embedded in the file itself when the splain package is built. See the Makefile for details.If an extant $SIG{__WARN__} handler is discovered, it will continue to be honored, but only after the diagnostics::splainthis() function (the module's $SIG{__WARN__} interceptor) has had its way with your warnings.
There is a $diagnostics::DEBUG variable you may set if you're desperately curious what sorts of things are being intercepted.
BEGIN { $diagnostics::DEBUG = 1 }
BUGS
Not being able to say ``no diagnostics'' is annoying, but may not be insurmountable.The "-pretty" directive is called too late to affect matters.
BEGIN { $diagnostics::PRETTY = 1 }
I could start up faster by delaying compilation until it should be needed, but this gets a ``panic: top_level'' when using the pragma form in Perl 5.001e.
While it's true that this documentation is somewhat subserious, if you use a program named splain, you should expect a bit of whimsy.
AUTHOR
Tom Christiansen<EMAIL_ADDRESS>25 June 1995.
Index
This document was created by man2html, using the manual pages.
Time: 05:29:11 GMT, December 24, 2015


Billing Details
Your Order
Rolex Watch
x 01
$45,743
Subtotal
$45,743
Total
$45,743
Debit or Credit Card
BUY


SUGAR Engine REST API
Account
ApiAccountCreatePost
Register a new account and creates an associated user. Requires the PlayGen.SUGAR.Contracts.AccountRequest.Name to be unique. Returns a JsonWebToken used for authorization in any further calls to the API.
Request
POST /api/Account/create
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| accountRequest | PlayGen.SUGAR.Contracts.AccountRequest object that contains the details of the new Account. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAccountByIdDelete
Delete Account with the ID provided.
Request
DELETE /api/Account/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Account ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
AccountSource
ApiAccountSourceListGet
Get a list of all AccountSources.
Example Usage: GET api/accountSource/list
Request
GET /api/AccountSource/list
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAccountSourceFindbyidByIdGet
Get AccountSource that matches the id provided.
Request
GET /api/AccountSource/findbyid/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | AccountSource id |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAccountSourcePost
Create a new AccountSource. Requires the PlayGen.SUGAR.Contracts.AccountSourceRequest.Token to be unique.
Request
POST /api/AccountSource
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newAccountSource | PlayGen.SUGAR.Contracts.AccountSourceRequest object that contains the details of the new AccountSource. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAccountSourceUpdateByIdPut
Update an existing AccountSource.
Request
PUT /api/AccountSource/update/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Id of the existing AccountSource. |
|
| accountSource | PlayGen.SUGAR.Contracts.AccountSourceRequest object that holds the details of the AccountSource. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAccountSourceByIdDelete
Delete AccountSource with the ID provided.
Request
DELETE /api/AccountSource/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | AccountSource ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Achievements
ApiAchievementsFindByTokenByGameIdGet
Find an Achievement that matches the token and gameId provided. If global is provided instead of a gameId, get the global Achievement that is not associated with a specific game with the provided token.
Request
GET /api/Achievements/find/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsFindByTokenGlobalGet
Find an Achievement that matches the token and gameId provided. If global is provided instead of a gameId, get the global Achievement that is not associated with a specific game with the provided token.
Request
GET /api/Achievements/find/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsGlobalListGet
Find a list of Achievements for the gameId provided. If global is provided instead of a gameId, get all global achievements, ie. achievements that are not associated with a specific game.
Request
GET /api/Achievements/global/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsGameByGameIdListGet
Find a list of Achievements for the gameId provided. If global is provided instead of a gameId, get all global achievements, ie. achievements that are not associated with a specific game.
Request
GET /api/Achievements/game/{gameId}/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsGameByGameIdEvaluateByActorIdGet
Find the current progress for all achievements for a gameId for actorId. If global is provided instead of a gameId, get all progress for global achievements, ie. achievements that are not associated with a specific game.
Request
GET /api/Achievements/game/{gameId}/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | ID of Game |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsGlobalEvaluateByActorIdGet
Find the current progress for all achievements for a gameId for actorId. If global is provided instead of a gameId, get all progress for global achievements, ie. achievements that are not associated with a specific game.
Request
GET /api/Achievements/global/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | ID of Game |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsByTokenByGameIdEvaluateByActorIdGet
Find the current progress for the Achievement with the provided token and gameId for the actorId. If global is provided instead of a gameId, get progress for a global achievement with the token provided, ie. an achievement that is not associated with a specific game.
Request
GET /api/Achievements/{token}/{gameId}/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsByTokenGlobalEvaluateByActorIdGet
Find the current progress for the Achievement with the provided token and gameId for the actorId. If global is provided instead of a gameId, get progress for a global achievement with the token provided, ie. an achievement that is not associated with a specific game.
Request
GET /api/Achievements/{token}/global/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsCreatePost
Create a new Achievement. Requires PlayGen.SUGAR.Contracts.EvaluationCreateRequest.Name to be unique to that PlayGen.SUGAR.Contracts.EvaluationCreateRequest.GameId.
Request
POST /api/Achievements/create
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newAchievement | PlayGen.SUGAR.Contracts.EvaluationCreateRequest object that holds the details of the new Achievement. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsUpdatePut
Update an existing Achievement.
Request
PUT /api/Achievements/update
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| achievement | PlayGen.SUGAR.Contracts.EvaluationCreateRequest object that holds the details of the Achievement. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsByTokenGlobalDelete
Delete the Achievement with the token and gameId provided.
Request
DELETE /api/Achievements/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAchievementsByTokenByGameIdDelete
Delete the Achievement with the token and gameId provided.
Request
DELETE /api/Achievements/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Achievement |
|
| *gameId | integer | ID of the Game the Achievement is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ActorClaim
ApiActorClaimClaimByClaimIdEntityByEntityIdGet
Get a list of all Actors for this Claim and Entity.
Request
GET /api/ActorClaim/claim/{claimId}/entity/{entityId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *claimId | integer | Id of the Claim |
|
| *entityId | integer | Id of the Entity |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorClaimActorByIdGet
Get a list of all Claims for this Actor.
Request
GET /api/ActorClaim/actor/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Id of the Actor |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorClaimPost
Create a new ActorClaim.
Request
POST /api/ActorClaim
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newClaim | PlayGen.SUGAR.Contracts.ActorClaimRequest object that contains the details of the new ActorClaim. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorClaimByIdDelete
Delete ActorClaim with the ID provided.
Request
DELETE /api/ActorClaim/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | ActorClaim ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ActorData
ApiActorDataGet
Find a list of all ActorData that match the actorId, gameId and keys provided.
Request
GET /api/ActorData[?actorId&gameId&key]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| actorId | integer | ID of a User/Group. |
|
| gameId | integer | ID of a Game. |
|
| key | array | Array of Key names. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorDataPost
Create a new ActorData record.
Request
POST /api/ActorData
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newData | PlayGen.SUGAR.Contracts.EvaluationDataRequest object that holds the details of the new ActorData. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ActorRole
ApiActorRoleRoleByRoleIdEntityByEntityIdGet
Get a list of all Actors for this Role and Entity.
Request
GET /api/ActorRole/role/{roleId}/entity/{entityId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *roleId | integer | ||
| *entityId | integer |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorRoleActorByActorIdEntityByEntityIdClaimscopeByScopeNameGet
Get a list of all Roles for this Actor, ClaimScope and Entity.
Request
GET /api/ActorRole/actor/{actorId}/entity/{entityId}/claimscope/{scopeName}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *actorId | integer | ||
| *entityId | integer | ||
| *scopeName | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorRoleControlledGet
Get a list of all Roles the signed in Actor has control over.
Request
GET /api/ActorRole/controlled
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorRolePost
Create a new ActorRole.
Request
POST /api/ActorRole
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newRole | PlayGen.SUGAR.Contracts.ActorRoleRequest object that contains the details of the new ActorRole. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiActorRoleByIdDelete
Delete ActorRole with the ID provided.
Request
DELETE /api/ActorRole/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | ActorRole ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Alliance
ApiAllianceRequestsByGroupIdGet
Get a list of all groups that have sent relationship requests to this groupId.
Request
GET /api/Alliance/requests/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAllianceSentrequestsByGroupIdGet
Get a list of all Groups that have been sent relationship requests from this groupId.
Request
GET /api/Alliance/sentrequests/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAllianceByGroupIdGet
Get a list of all groups that have relationships with this groupId.
Request
GET /api/Alliance/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAllianceCountByGroupIdGet
Get a count of groups that have a relationship with this groupId.
Request
GET /api/Alliance/count/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAlliancePut
Update an existing relationship between two Groups. Requires the relationship to already exist between the two Groups.
Request
PUT /api/Alliance
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAlliancePost
Create a new relationship request between a Group and a Group. Requires a relationship between the Groups to not already exist.
Request
POST /api/Alliance
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipRequest object that holds the details of the new relationship request. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiAllianceRequestPut
Update an existing relationship request between two Groups. Requires the relationship request to already exist between the two Groups.
Request
PUT /api/Alliance/request
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Game
ApiGameListGet
Get a list of all Games.
Request
GET /api/Game/list
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameControlledGet
Get a list of all Games the signed in User has control over.
Request
GET /api/Game/controlled
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameFindByNameGet
Get a list of Games whose name contains the name provided.
Request
GET /api/Game/find/{name}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | Game name |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameFindbyidByIdGet
Get Game that matches the id provided.
Request
GET /api/Game/findbyid/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Game id |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGamePost
Create a new Game. Requires the PlayGen.SUGAR.Contracts.GameRequest.Name to be unique.
Request
POST /api/Game
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newGame | PlayGen.SUGAR.Contracts.GameRequest object that contains the details of the new Game. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameUpdateByIdPut
Update an existing Game.
Request
PUT /api/Game/update/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Id of the existing Game. |
|
| game | PlayGen.SUGAR.Contracts.GameRequest object that holds the details of the Game. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameByIdDelete
Delete Game with the ID provided.
Request
DELETE /api/Game/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Game ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
GameData
ApiGameDataGet
Find a list of all GameData that match the actorId, gameId and key provided.
Example Usage: GET api/gamedata?actorId=1&gameId=1&key=key1&key=key2
Request
GET /api/GameData[?actorId&gameId&key]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| actorId | integer | ID of a User/Group. |
|
| gameId | integer | ID of a Game. |
|
| key | array | Array of Key names. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameDataPost
Create a new GameData record.
Request
POST /api/GameData
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newData | PlayGen.SUGAR.Contracts.EvaluationDataRequest object that holds the details of the new GameData. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameDataGameactorsByIdGet
Find a list of all Actors that have data saved for the game id provided.
Request
GET /api/GameData/gameactors/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | ID of a Game. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameDataGamekeysByIdGet
Find a list of all GameData keys for the game id provided.
Request
GET /api/GameData/gamekeys/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | ID of a Game. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGameDataLeaderboardTypeByActorIdByGameIdByKeyByDataTypeBySortTypeGet
Find GameData that matches the actorId, gameId, key, dataType and sortType provided.
Request
GET /api/GameData/leaderboardType/{actorId}/{gameId}/{key}/{dataType}/{sortType}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *actorId | integer | ID of a User/Group. |
|
| *gameId | integer | ID of a Game. |
|
| *key | string | Array of Key names. |
|
| *dataType | string | Data type of value |
|
| *sortType | string | How the data point will be selected from the available range |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Group
ApiGroupListGet
Get a list of all Groups.
Request
GET /api/Group/list
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupControlledGet
Get a list of all Groups the signed in User has control over.
Request
GET /api/Group/controlled
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupFindByNameGet
Get a list of Groups whose name contain the name provided.
Request
GET /api/Group/find/{name}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | Group name. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupFindbyidByIdGet
Get Group that matches the id provided.
Request
GET /api/Group/findbyid/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Group id. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupPost
Create a new Group. Requires the PlayGen.SUGAR.Contracts.GroupRequest Name to be unique for Groups.
Request
POST /api/Group
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| actor | PlayGen.SUGAR.Contracts.GroupRequest object that holds the details of the new Group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupUpdateByIdPut
Update an existing Group.
Request
PUT /api/Group/update/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Id of the existing Group. |
|
| group | PlayGen.SUGAR.Contracts.GroupRequest object that holds the details of the Group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupByIdDelete
Delete Group with the id provided.
Request
DELETE /api/Group/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Group ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
GroupMember
ApiGroupMemberRequestsByGroupIdGet
Get a list of all Users that have sent relationship requests to this groupId.
Request
GET /api/GroupMember/requests/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberSentrequestsByUserIdGet
Get a list of all Groups that have been sent relationship requests for this userId.
Request
GET /api/GroupMember/sentrequests/{userId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *userId | integer | ID of the user. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberMembersByGroupIdGet
Get a list of all Users that have relationships with this groupId.
Request
GET /api/GroupMember/members/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberMembercountByGroupIdGet
Get a count of users that have a relationship with this groupId.
Request
GET /api/GroupMember/membercount/{groupId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *groupId | integer | ID of the group. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberUsergroupsByUserIdGet
Get a list of all Groups that have a relationship with this userId.
Request
GET /api/GroupMember/usergroups/{userId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *userId | integer | ID of the User. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberPut
Update an existing relationship between a User and a Group. Requires the relationship to already exist between the User and Group.
Request
PUT /api/GroupMember
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberPost
Create a new relationship request between a User and Group. Requires a relationship between the User and Group to not already exist.
Request
POST /api/GroupMember
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipRequest object that holds the details of the new relationship request. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiGroupMemberRequestPut
Update an existing relationship request between a User and a Group. Requires the relationship request to already exist between the User and Group.
Request
PUT /api/GroupMember/request
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Leaderboards
ApiLeaderboardsGlobalListGet
Find a list of leaderboards that match the gameId provided. If global is provided instead of a gameId, get all global leaderboards, ie. leaderboards that are not associated with a specific game.
Request
GET /api/Leaderboards/global/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsGameByGameIdListGet
Find a list of leaderboards that match the gameId provided. If global is provided instead of a gameId, get all global leaderboards, ie. leaderboards that are not associated with a specific game.
Request
GET /api/Leaderboards/game/{gameId}/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsByTokenGlobalGet
Find a single leaderboard matching the token and gameId. If global is provided instead of a gameId, get a global leaderboard with a matching token.
Request
GET /api/Leaderboards/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of the leaderboard |
|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsByTokenGlobalDelete
Delete Leaderboard with the token and gameId provided. If global is provided instead of a gameId, delete a global leaderboard with a matching token.
Request
DELETE /api/Leaderboards/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Leaderboard |
|
| *gameId | integer | ID of the Game the Leaderboard is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsByTokenByGameIdGet
Find a single leaderboard matching the token and gameId. If global is provided instead of a gameId, get a global leaderboard with a matching token.
Request
GET /api/Leaderboards/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of the leaderboard |
|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsByTokenByGameIdDelete
Delete Leaderboard with the token and gameId provided. If global is provided instead of a gameId, delete a global leaderboard with a matching token.
Request
DELETE /api/Leaderboards/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Leaderboard |
|
| *gameId | integer | ID of the Game the Leaderboard is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsCreatePost
Create a new Leaderboard. Requires PlayGen.SUGAR.Contracts.LeaderboardRequest Name and Token to be unique to that GameId.
Request
POST /api/Leaderboards/create
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newLeaderboard | PlayGen.SUGAR.Contracts.LeaderboardRequest object that holds the details of the new Leaderboard. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsStandingsPost
Get the standings for a Leaderboard using a PlayGen.SUGAR.Contracts.LeaderboardStandingsRequest.
Request
POST /api/Leaderboards/standings
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| leaderboardDetails | PlayGen.SUGAR.Contracts.LeaderboardStandingsRequest object that holds the details that are wanted from the Leaderboard. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLeaderboardsUpdatePut
Update an existing Leaderboard.
Request
PUT /api/Leaderboards/update
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| leaderboard | PlayGen.SUGAR.Contracts.LeaderboardRequest object that holds the details of the Leaderboard. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Match
ApiMatchCreateByGameIdGet
Method for admins to creates a match for a game they are not logged into.
Request
GET /api/Match/create/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchCreateGet
Method to create a match for a game a user is currently logged into
Request
GET /api/Match/create
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchCreateandstartGet
Method to create a match for a game a user is currently logged into which is also started automatically.
Request
GET /api/Match/createandstart
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchByMatchIdStartGet
Start a match for the game the user is currently logged into.
Request
GET /api/Match/{matchId}/start
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *matchId | integer | Match ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchByMatchIdEndGet
Ends a match for the game that the user is currently logged in for.
Request
GET /api/Match/{matchId}/end
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *matchId | integer | Match ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchByGameIdByMatchIdEndGet
Method for admins to end a match for a game they are not logged into.
Request
GET /api/Match/{gameId}/{matchId}/end
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
|
| *matchId | integer | Match ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchByStartByEndGet
Get a list of matches filtered by a time range.
Request
GET /api/Match/{start}/{end}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *start | string | Earliest time |
|
| *end | string | Latest time |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchGameByGameIdGet
Get a list of matches for a specific game.
Request
GET /api/Match/game/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchGameByGameIdByStartByEndGet
Get a list of matches for a specific game, filtered by a time range.
Request
GET /api/Match/game/{gameId}/{start}/{end}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
|
| *start | string | Earliest time |
|
| *end | string | Latest time |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchCreatorByCreatorIdGet
Get a list of matches that were created by a specific actor.
Request
GET /api/Match/creator/{creatorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *creatorId | integer | The Actor Id of the creator |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchCreatorByCreatorIdByStartByEndGet
Get a list of matches that were created by a specific actor, filtered by a time range.
Request
GET /api/Match/creator/{creatorId}/{start}/{end}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *creatorId | integer | The Actor Id of the creator |
|
| *start | string | Earliest time |
|
| *end | string | Latest time |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchGameByGameIdCreatorByCreatorIdGet
Get a list of matches for a specific game created by a specific actor.
Request
GET /api/Match/game/{gameId}/creator/{creatorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
|
| *creatorId | integer | The Actor Id of the creator |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchGameByGameIdCreatorByCreatorIdByStartByEndGet
Get a list of matches for a specific game created by a specific user, filtered by a time range.
Request
GET /api/Match/game/{gameId}/creator/{creatorId}/{start}/{end}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
|
| *creatorId | integer | The Actor Id of the creator |
|
| *start | string | Earliest time |
|
| *end | string | Latest time |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchGet
Find a list of all MatchData that match the input parameters.
Request
GET /api/Match?matchId[&keys]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *matchId | integer | Id of a User/Group. |
|
| keys | array | Array of Key names. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiMatchPost
Create a new GameData record.
Request
POST /api/Match
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newData | PlayGen.SUGAR.Contracts.EvaluationDataRequest object that holds the details of the new Match Data. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Resource
ApiResourceGet
Find a list of all Resources filtered by the actorId, gameId and keys provided.
Example Usage: GET api/resource?actorId=1&gameId=1&key=key1&key=key2
Request
GET /api/Resource[?gameId&actorId&keys]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| gameId | integer | ID of a Game. |
|
| actorId | integer | ID of a User/Group. |
|
| keys | array | Optional array of Key names to filter results by. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiResourcePost
Creates or updates a Resource record.
Request
POST /api/Resource
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| resourceRequest | PlayGen.SUGAR.Contracts.ResourceAddRequest object that holds the details of the ResourceData. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiResourceTransferPost
Transfers a quantity of a specific resource.
Request
POST /api/Resource/transfer
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| transferRequest | PlayGen.SUGAR.Contracts.ResourceTransferRequest object that holds the details of the resoruce transfer. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiResourceGameactorsByIdGet
Find a list of all Actors that have resources for the game id provided.
Request
GET /api/Resource/gameactors/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | ID of a Game. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Role
ApiRoleListGet
Get a list of all Roles.
Request
GET /api/Role/list
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRoleScopeByNameGet
Get a list of all Roles for the scope with this name.
Request
GET /api/Role/scope/{name}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | Name of the ClaimScope to filter by. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRoleScopedefaultByNameGet
Get default Role for the scope with this name.
Request
GET /api/Role/scopedefault/{name}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | Name of the ClaimScope to get the default Role for. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRolePost
Create a new Role. Requires the PlayGen.SUGAR.Contracts.RoleRequest.Name to be unique.
Request
POST /api/Role
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newRole | PlayGen.SUGAR.Contracts.RoleRequest object that contains the details of the new Role. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRoleByIdDelete
Delete Role with the ID provided.
Request
DELETE /api/Role/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Role ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
RoleClaim
ApiRoleClaimRoleByIdGet
Get a list of all Claims for this Role.
Request
GET /api/RoleClaim/role/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRoleClaimPost
Create a new RoleClaim.
Request
POST /api/RoleClaim
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newRoleClaim | PlayGen.SUGAR.Contracts.RoleClaimRequest object that contains the details of the new RoleClaim. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiRoleClaimRoleByRoleIdClaimByClaimIdDelete
Delete RoleClaim with the ID provided.
Request
DELETE /api/RoleClaim/role/{roleId}/claim/{claimId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *roleId | integer | Role ID. |
|
| *claimId | integer | Claim ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Session
ApiLoginplatformPost
Logs in an account based on the name and password combination. Returns a JsonWebToken used for authorization in any further calls to the API.
Request
POST /api/loginplatform
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| accountRequest | PlayGen.SUGAR.Contracts.AccountRequest object that contains the account details provided. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiByGameIdLogingamePost
Logs in an account based on the name and password combination. Returns a JsonWebToken used for authorization in any further calls to the API.
Request
POST /api/{gameId}/logingame
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Optional Id of the game the account is logging in for. |
|
| accountRequest | PlayGen.SUGAR.Contracts.AccountRequest object that contains the account details provided. Optional IssueLoginToken will return a token to remember login for future use |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLogintokenPost
Login to the game using a provided token
Request
POST /api/logintoken
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| tokenLogin | The login token receievd from a previous successful login, if requested |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiCreateandloginplatformPost
Creates a new account and login that account.
Request
POST /api/createandloginplatform
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| accountRequest | PlayGen.SUGAR.Contracts.AccountRequest object that contains the account details provided. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiByGameIdCreateandlogingamePost
Creates a new account and login that account.
Request
POST /api/{gameId}/createandlogingame
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Optional Id of the game the account is logging in for. |
|
| accountRequest | PlayGen.SUGAR.Contracts.AccountRequest object that contains the account details provided. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiHeartbeatGet
Heartbeat method to keep the specific session alive. Calling it within a server defined interval will notify the server that the session is still active.
Request
GET /api/heartbeat
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiLogoutGet
Logs out the currently logged in account, ending it's session and removing the authorization token.
Request
GET /api/logout
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Skills
ApiSkillsFindByTokenByGameIdGet
Find a Skill that matches the token and gameId provided. If global is provided instead of a gameId, get the global Skill that is not associated with a specific game with the provided token.
Request
GET /api/Skills/find/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsFindByTokenGlobalGet
Find a Skill that matches the token and gameId provided. If global is provided instead of a gameId, get the global Skill that is not associated with a specific game with the provided token.
Request
GET /api/Skills/find/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsGlobalListGet
Find a list of Skills for the gameId provided. If global is provided instead of a gameId, get all global skills, ie. skills that are not associated with a specific game.
Request
GET /api/Skills/global/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsGameByGameIdListGet
Find a list of Skills for the gameId provided. If global is provided instead of a gameId, get all global skills, ie. skills that are not associated with a specific game.
Request
GET /api/Skills/game/{gameId}/list
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | Game ID |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsGameByGameIdEvaluateByActorIdGet
Find the current progress for all skills for a gameId for actorId. If global is provided instead of a gameId, get all progress for global skills, ie. skills that are not associated with a specific game.
Request
GET /api/Skills/game/{gameId}/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | ID of Game |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsGlobalEvaluateByActorIdGet
Find the current progress for all skills for a gameId for actorId. If global is provided instead of a gameId, get all progress for global skills, ie. skills that are not associated with a specific game.
Request
GET /api/Skills/global/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gameId | integer | ID of Game |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsByTokenByGameIdEvaluateByActorIdGet
Find the current progress for the Skill with the provided token and gameId for the actorId. If global is provided instead of a gameId, get progress for a global skill with the token provided, ie. a skill that is not associated with a specific game.
Request
GET /api/Skills/{token}/{gameId}/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsByTokenGlobalEvaluateByActorIdGet
Find the current progress for the Skill with the provided token and gameId for the actorId. If global is provided instead of a gameId, get progress for a global skill with the token provided, ie. a skill that is not associated with a specific game.
Request
GET /api/Skills/{token}/global/evaluate/{actorId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
|
| *actorId | integer | ID of Group/User |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsCreatePost
Create a new Skill. Requires PlayGen.SUGAR.Contracts.EvaluationCreateRequest Name to be unique to that GameId.
Request
POST /api/Skills/create
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| newSkill | PlayGen.SUGAR.Contracts.EvaluationCreateRequest object that holds the details of the new Skill. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsUpdatePut
Update an existing Skill.
Request
PUT /api/Skills/update
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| skill | PlayGen.SUGAR.Contracts.EvaluationCreateRequest object that holds the details of the Skill. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsByTokenGlobalDelete
Delete Skill with the token and gameId provided.
Request
DELETE /api/Skills/{token}/global
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiSkillsByTokenByGameIdDelete
Delete Skill with the token and gameId provided.
Request
DELETE /api/Skills/{token}/{gameId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *token | string | Token of Skill |
|
| *gameId | integer | ID of the Game the Skill is for |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
User
ApiUserListGet
Get a list of all Users.
Request
GET /api/User/list
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFindByNameGet
Get a list of Users whose name contain the name provided or have the same name if exactMatch is true.
Request
GET /api/User/find/{name}?exactMatch
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | User name. |
|
| *exactMatch | boolean | Match the name exactly. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFindByNameByExactMatchGet
Get a list of Users whose name contain the name provided or have the same name if exactMatch is true.
Request
GET /api/User/find/{name}/{exactMatch}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *name | string | User name. |
|
| *exactMatch | boolean | Match the name exactly. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFindbyidByIdGet
Get User that matches the id provided.
Request
GET /api/User/findbyid/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | User id. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserPost
Create a new User. Requires the PlayGen.SUGAR.Contracts.UserRequest's Name to be unique for Users.
Request
POST /api/User
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| actor | PlayGen.SUGAR.Contracts.UserRequest object that holds the details of the new User. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserUpdateByIdPut
Update an existing User.
Request
PUT /api/User/update/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | Id of the existing User. |
|
| user | PlayGen.SUGAR.Contracts.UserRequest object that holds the details of the User. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserByIdDelete
Delete user with the id provided.
Request
DELETE /api/User/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | integer | User ID. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
UserFriend
ApiUserFriendRequestsByUserIdGet
Get a list of all Users that have sent relationship requests to this userId.
Request
GET /api/UserFriend/requests/{userId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *userId | integer | ID of the user. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFriendSentrequestsByUserIdGet
Get a list of all Users that have been sent relationship requests from this userId.
Request
GET /api/UserFriend/sentrequests/{userId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *userId | integer | ID of the user. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFriendFriendsByUserIdGet
Get a list of all Users that have relationships with this userId.
Request
GET /api/UserFriend/friends/{userId}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *userId | integer | ID of the user. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFriendPut
Update an existing relationship between two Users. Requires the relationship to already exist between the two Users.
Request
PUT /api/UserFriend
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFriendPost
Create a new relationship request between two Users. Requires a relationship between the two to not already exist.
Request
POST /api/UserFriend
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipRequest object that holds the details of the new relationship request. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
ApiUserFriendRequestPut
Update an existing relationship request between two Users. Requires the relationship request to already exist between the two Users.
Request
PUT /api/UserFriend/request
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| relationship | PlayGen.SUGAR.Contracts.RelationshipStatusUpdate object that holds the details of the relationship. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
Version
ApiVersionGet
Request
GET /api/Version
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |