FIfireserviceusa
JobReferral

Gets the entities assigned to a specific job

get/api/v1/jobs/{jobId}/referrals/entities

Request

  • Base URL
    https://api.fireserviceusa.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.fireserviceusa.com/api/v1/jobs/{jobId}/referrals/entities
  • Auth
    none declared

Path parameters

jobIdinteger required

The job ID

Response

Success

AccountIdinteger

The account ID

DisplayNamestring nullable

The display name

AccountTypestring nullable

The account type

ReferralTypestring nullable

The referral type

CommissionRatenumber double nullable

The commission rate

AssignmentDatestring date-time

The assignment date

Levelinteger

The level in hierarchy

HierarchyPathNamesstring nullable

The hierarchy path names

HierarchyPathIdsstring nullable

The hierarchy path IDs

IsDirectReferralboolean

Whether this is a direct referral

IsEnrolledInLoyaltyRewardsProgramboolean

Whether the referring entity is enrolled in the loyalty rewards program

IsActiveboolean

Whether the account is active

Changes

No operation changes recorded.