Match Staff/Officials

Request: GET

Returns a list of match staff/officials that the user has access to.

HTTP Request


			GET /v1/{sport}/leagues/{leagueId}/staff

			GET /v1/{sport}/competition/{competitionId}/staff

			GET /v1/{sport}/matches/{matchId}/staff

			GET /v1/{sport}/matches/{matchId}/persons/{personId}/staff

			GET /v1/{sport}/matches/{matchId}/teams/{teamId}/staff

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`leagueId`	`integer`	Unique identifier for the league the person is in.
Optional Parameters
`competitionId`	`integer`	Unique identifier for a competition
`matchId`	`integer`	Unique identifier for a match
`teamId`	`integer`	Unique identifier for a team
`personId`	`integer`	Unique identifier for a person
`staffType`	`string`	Type of staff role defined in Match Staff Resource
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the league, then the URL parameters `matchId`, `personId`, `teamId` and `competitionId` will instead refer to the `externalId` fields of the respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a list of Match Staff resources.

Request: GET

Get the detail about a person performing a role in a specific match.

HTTP Request


			GET /v1/{sport}/matches/{matchId}/staff/{staffType}/persons/{personId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`matchId`	`integer`	Unique identifier for a match
`personId`	`integer`	Unique identifier for a person
`staffType`	`string`	Type of staff role defined in Match Staff Resource
Optional Parameters
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the league, then the URL parameters `matchId` and `personId` will instead refer to the `externalId` fields of the respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a Match Staff resource.

Request: POST, Request: PUT

Create detail about a specific person's relation to a particular match. Both the PUT and POST verbs are accepted as the system will handle any creation/editing logic.

Note: Only the fields being sent for the resource will be returned. For a full list of fields, do a detail call as above.

HTTP Request


			POST /v1/{sport}/leagues/{leagueId}/staff

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`leagueId`	`integer`	Unique identifier for the league the matches are in
Optional Parameters
`minimumResponse`	`integer`	If this value is set to 1 then the response resource will only contain contain minimal identifying fields.
`bulk`	`integer`	Create multiple records.
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the content of the request body is interpreted differently. See the Request Body section for more information.

Request Body

In the request body supply a Match Staff resource. If the bulk parameter is specified a list of resources is expected.

If the useExternalForLeague parameter is specified, then the following fields in the resource will be interpreted as the externalId of the specific entity instead of the unique identifier.

matchId
teamId
personId

Response

If successful this method returns a Match Staff resource. If the bulk parameter is specified it will return a list of resources. Any errors returned are against the specific resource.

Request: DELETE

Delete an existing match staff record

HTTP Request


			   DELETE /v1/{sport}/matches/{matchId}/staff

			   DELETE /v1/{sport}/matches/{matchId}/staff/{staffType}/persons/{personId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`matchId`	`integer`	Unique identifier for a match
Optional Parameters
`personId`	`integer`	Unique identifier for a person
`staffType`	`string`	Type of staff role defined in Match Staff Resource
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the URL parameters `matchId` and `personId` will instead refer to the `externalId` fields of the respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

Successful this method returns SUCCESS.