Referees and umpires are typically referred to collectively as officials. We are in the process of removing the term "referee" from Assignr and replacing it with "official", as baseball umpires do not refer to themselves as referees.
Administrators who are responsible for assigning officials are called assignors. Although "assigner" is also a correct spelling of the same word, we use the word assignor to refer to the individuals who assign officials to games.
An Account represents the username/password that an individual person uses to login to Assignr. Each person accessing Assignr should only have one Account. In some circumstances, one person may have more than one Account, but this isn't typical.
A Site represents a specific Assignr site. Each Site typically represents a league or a referee association. Each Account can belong to one or more Sites. If an umpire works games for more than one umpire association, they might belong to more than one Site. They can access each Site with their Account credentials.
A User represent's a specific umpire/referee/assignor's profile within one Site. For example, Joe Schmoe works for both the North Cascades Referee Alliance and the Upper Whatcom Baseball Umpire Association. Joe will access Assignr using his Account credentials, and has two User records, one for each organization he works with.
A User can also be though of as a "user profile".
A Game is exactly what you think it is... it is an event that exists at a specific day/time/location, is played by two teams, and has officials assigned to it.
Each game has one or more Assignments. Each Assignment is a spot where an official can be assigned. If the assignor has done their job correctly, every Assignment has an official assigned to it, noted by the presence of a User on the Assignment record. In some cases, when no one is available for a specific Assignment, it might not have an official assigned to it.
Each Assignment will also note the Position. The position notes the type of official that is assigned to work a game. For example, in Soccer, a game that requires four officials has one Referee, two Assistant Referees, and a Fourth Official. Some Soccer games might only need one Referee.
Assignments should be displayed in the order noted in the sort_order field.
When an official is assigned to a game, they are notified by email and they are expected to login to Assignr and click the Accept or Decline button next to the game. When the game is accepted, the official is committing to work the game. When the game is declined, the official is turning the game back over to the assignor, so that someone else can be assigned.
Each official logs into Assignr and indicates the days they are available to work. Each Availability entry notes whether they are available for the entire day, or part of a day. An official can also be available for multiple parts of the day, such as "December 2, between 8am-noon and between 6pm and 11pm"
For customers located in the USA, they can optionally enable direct deposit for their Site. When enabled, an official can enter their banking information, and can be paid via ACH.
The API can be used to view the name of an attached bank account, or remove an existing bank account.
A Statement is a list of games and fees that have been approved for payment to a specific official, similar to an invoice. For Sites using our payment platform, they create a Statement when a set of games have been approved for payment. For officials who are paid monthly basis, an assignor might approve games for payment on a weekly basis, and then initiate payment to an official at the end of the month.
Once an assignor is ready to pay an official, they will use the Assignr site to initiate the payment process. The official is notified that a payment has been started. The money appears in their bank account in 1-3 business days, and they are notified when it has been successfully deposited. Each statement indicates the total amount owed, and has a status that indicates whether a statement is unpaid, in process, paid, or failed to be paid.