GET api/Bonus?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available bonus types for a LocationID or CompanyID

Request Information

Parameters

NameDescriptionAdditional information
AuthenticationGUID
The Authentication GUID provided to you by your Account Manager

Define this parameter in the request URI.

PartyID
PartyID is an identifier for Employee, Company or Location

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "DisplaySequence": "sample string 3",
    "ID": "sample string 4",
    "Status": "sample string 5",
    "VariableStatus": "sample string 6"
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "DisplaySequence": "sample string 3",
    "ID": "sample string 4",
    "Status": "sample string 5",
    "VariableStatus": "sample string 6"
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "DisplaySequence": "sample string 3",
    "ID": "sample string 4",
    "Status": "sample string 5",
    "VariableStatus": "sample string 6"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMainAPI.VariableValueLookupClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFAPIWeb">
  <MainAPI.VariableValueLookupClass>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <DisplaySequence>sample string 3</DisplaySequence>
    <ID>sample string 4</ID>
    <Status>sample string 5</Status>
    <VariableStatus>sample string 6</VariableStatus>
  </MainAPI.VariableValueLookupClass>
  <MainAPI.VariableValueLookupClass>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <DisplaySequence>sample string 3</DisplaySequence>
    <ID>sample string 4</ID>
    <Status>sample string 5</Status>
    <VariableStatus>sample string 6</VariableStatus>
  </MainAPI.VariableValueLookupClass>
  <MainAPI.VariableValueLookupClass>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <DisplaySequence>sample string 3</DisplaySequence>
    <ID>sample string 4</ID>
    <Status>sample string 5</Status>
    <VariableStatus>sample string 6</VariableStatus>
  </MainAPI.VariableValueLookupClass>
</ArrayOfMainAPI.VariableValueLookupClass>