{ "opencollection": "1.0.0", "info": { "name": "Fixtures-v2", "version": "2.0.280" }, "items": [ { "info": { "name": "competitions", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competition by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitions", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId)" } ] }, "docs": "Returns competitions wrapped inside a HATEOAS model" }, { "info": { "name": "Create new competition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/competitions", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new competition" }, { "info": { "name": "Update existing competition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/competitions", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing competition" }, { "info": { "name": "Patch existing competition", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/competitions", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Patch existing competition" }, { "info": { "name": "Retrieve competition details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitions/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competition ID to return details for" } ] }, "docs": "Returns competition details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing competition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/competitions/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing competition" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "OPTIONS /competitions", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitions" } }, { "info": { "name": "OPTIONS /competitions/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitions/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors" } }, { "info": { "name": "OPTIONS /competitors/doubles", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/doubles" } }, { "info": { "name": "OPTIONS /competitors/doubles/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/doubles/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/doubles/{id}/contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/doubles/:id/contracts", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/doubles/{id}/rounds", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/doubles/:id/rounds", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/doubles/{id}/seasons", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/doubles/:id/seasons", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/horses", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/horses" } }, { "info": { "name": "OPTIONS /competitors/horses/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/horses/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/players", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/players" } }, { "info": { "name": "OPTIONS /competitors/players/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/players/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/players/{id}/contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/players/:id/contracts", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/players/{id}/rounds", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/players/:id/rounds", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/players/{id}/seasons", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/players/:id/seasons", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/tbds", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/tbds" } }, { "info": { "name": "OPTIONS /competitors/tbds/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/tbds/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/teams", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/teams" } }, { "info": { "name": "OPTIONS /competitors/teams/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/teams/{id}/contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/teams/:id/contracts", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/teams/{id}/rounds", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/teams/:id/rounds", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/teams/{id}/seasons", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/teams/:id/seasons", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /competitors/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/competitors/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/contracts" } }, { "info": { "name": "OPTIONS /fixtures", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures" } }, { "info": { "name": "OPTIONS /fixtures/refdata", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/refdata" } }, { "info": { "name": "OPTIONS /fixtures/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /fixtures/{id}/contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/:id/contracts", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /fixtures/{id}/lineups", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/:id/lineups", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /fixtures/{id}/officials", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/:id/officials", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /fixtures/{id}/officials/{personId}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/fixtures/:id/officials/:personId", "params": [ { "name": "personId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /groups", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/groups" } }, { "info": { "name": "OPTIONS /groups/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/groups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /ingestion/competitions/searchById", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/competitions/searchById" } }, { "info": { "name": "OPTIONS /ingestion/competitions/searchBySourceEntityId", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/competitions/searchBySourceEntityId" } }, { "info": { "name": "OPTIONS /ingestion/competitions/{trackingRequestId}/status", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/competitions/:trackingRequestId/status", "params": [ { "name": "trackingRequestId", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /ingestion/fixtures/searchById", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/fixtures/searchById" } }, { "info": { "name": "OPTIONS /ingestion/fixtures/searchBySourceEntityId", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/fixtures/searchBySourceEntityId" } }, { "info": { "name": "OPTIONS /ingestion/fixtures/{trackingRequestId}/status", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/fixtures/:trackingRequestId/status", "params": [ { "name": "trackingRequestId", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /ingestion/squads/searchById", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/squads/searchById" } }, { "info": { "name": "OPTIONS /ingestion/squads/searchBySourceEntityId", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/squads/searchBySourceEntityId" } }, { "info": { "name": "OPTIONS /ingestion/squads/{trackingRequestId}/status", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/ingestion/squads/:trackingRequestId/status", "params": [ { "name": "trackingRequestId", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /localities", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/localities" } }, { "info": { "name": "OPTIONS /localities/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/localities/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /organizations", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/organizations" } }, { "info": { "name": "OPTIONS /organizations/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/organizations/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /persons", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/persons" } }, { "info": { "name": "OPTIONS /persons/coaches", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/persons/coaches" } }, { "info": { "name": "OPTIONS /persons/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/persons/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /persons/{id}/contracts", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/persons/:id/contracts", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /persons/{id}/officials", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/persons/:id/officials", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /rounds", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/rounds" } }, { "info": { "name": "OPTIONS /rounds/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/rounds/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /rounds/{id}/competitors", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/rounds/:id/competitors", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /seasons", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/seasons" } }, { "info": { "name": "OPTIONS /seasons/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/seasons/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /seasons/{id}/competitors", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/seasons/:id/competitors", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /sourcerequests/{requestId}/status", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/sourcerequests/:requestId/status", "params": [ { "name": "requestId", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /sports", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/sports" } }, { "info": { "name": "OPTIONS /sports/{id}/{entityType}/metadata", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/sports/:id/:entityType/metadata", "params": [ { "name": "entityType", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "OPTIONS /venues", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/venues" } }, { "info": { "name": "OPTIONS /venues/{id}", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/venues/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "competitors", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors basic info regardless their type with reference to the detailed endpoint. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType, competitorType)" } ] }, "docs": "Retrieve competitors basic info regardless their type with reference to the detailed endpoint wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors ID to return information for" } ] }, "docs": "Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID." }, { "info": { "name": "Delete existing existing competitor of any type - Team, Player, Double partnership etc", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/competitors/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing existing competitor of any type - Team, Player, Double partnership etc" } ] }, { "info": { "name": "competitors/doubles", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors (doubles) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/doubles", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" } ] }, "docs": "Returns competitors (doubles) wrapped inside a HATEOAS model" }, { "info": { "name": "Create new double partnership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/competitors/doubles", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new double partnership" }, { "info": { "name": "Update existing double partnership", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/competitors/doubles", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing double partnership" }, { "info": { "name": "Retrieve competitors (doubles) details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/doubles/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors (doubles) ID to return details for" } ] }, "docs": "Returns competitors (doubles) details including sport specific details (metadata properties)" }, { "info": { "name": "Retrieve rounds in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/doubles/:id/rounds", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (doubles) ID to return details for" } ] }, "docs": "Returns the rounds in which the doubles partnership will take part by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve seasons in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/doubles/:id/seasons", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (doubles) ID to return details for" } ] }, "docs": "Returns the seasons in which the Doubles Partnership will take part by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model" } ] }, { "info": { "name": "contracts", "type": "folder" }, "items": [ { "info": { "name": "Retrieve persons which are part of the doubles partnership by Doubles Partnership ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/doubles/:id/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from, to)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from, to, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (doubles) ID to return details for" } ] }, "docs": "Returns the persons which are part of the doubles partnership by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve persons which are associated with the current player (e.g. coaches) by Player ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/players/:id/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (players) ID to return details for" } ] }, "docs": "Returns the persons which are associated with the current player (e.g. coaches) by GSS Player Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve persons which are part of the team (a.k.a. Rosters) or persons which were part of the team by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/teams/:id/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from, to)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from, to, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (teams) ID to return details for" } ] }, "docs": "Returns the persons which were or are part of the team by GSS Team Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve contracts between person and different types of competitors.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (competitor.Id, competitor.Name, person.Id, person.Name, player.Id, player.Name, createdon, modifiedon, updatedcount, startDate, endDate, isactive)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (competitor.Id, competitor.Name, person.Id, person.Name, player.Id, player.Name, createdon, modifiedon, updatedcount, startDate, endDate, isactive)" } ] }, "docs": "Returns the persons, the corresponding player and the competitor with which the person has contract of wrapped inside a HATEOAS model" }, { "info": { "name": "Create new contract between competitor of any type and person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/contracts", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new contract between competitor of any type and person" }, { "info": { "name": "Update existing contract between competitor of any type and person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/contracts", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing contract between competitor of any type and person" }, { "info": { "name": "Create new contract between competitor and person who has a team official role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/contracts/officials", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new contract between competitor and person who has a team official role" }, { "info": { "name": "Delete existing contract by team and person Ids", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/contracts/team/:teamId/person/:personId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "teamId", "value": "", "type": "path" }, { "name": "personId", "value": "", "type": "path" } ] }, "docs": "Delete existing contract by team and person Ids" }, { "info": { "name": "Delete existing contract by team and player Ids", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/contracts/team/:teamId/player/:playerId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "playerId", "value": "", "type": "path" }, { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "Delete existing contract by team and player Ids" }, { "info": { "name": "Delete existing contract by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/contracts/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing contract by id" }, { "info": { "name": "Retrieve a snapshot of the contracts that were active for the competitors which were part of the fixture when the fixture took place.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures/:id/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed." }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators." }, { "name": "id", "value": "", "type": "path", "description": "Single fixture ID to return officials for" } ] }, "docs": "Returns the competitor, the person and the corresponding player" }, { "info": { "name": "Retrieve teams/doubles partnerships/players/etc in which the person takes (as coach, player in team, owner etc.) part by Person ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/persons/:id/contracts", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single person ID to return details for" } ] }, "docs": "Returns the teams/doubles partnership/players/etc in which the person takes part by GSS Person Id in the path, wrapped inside a HATEOAS model" } ] }, { "info": { "name": "competitors/horses", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors (horses) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/horses", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" } ] }, "docs": "Returns competitors (horses) wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve competitors (horses) details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/horses/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors (horses) ID to return details for" } ] }, "docs": "Returns competitors (horses) details including sport specific details (metadata properties)" } ] }, { "info": { "name": "competitors/players", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors (players) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/players", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" } ] }, "docs": "Returns competitors (players) wrapped inside a HATEOAS model" }, { "info": { "name": "Create new player", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/competitors/players", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new player" }, { "info": { "name": "Update existing player", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/competitors/players", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing player" }, { "info": { "name": "Retrieve competitors (players) details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/players/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors (players) ID to return details for" } ] }, "docs": "Returns competitors (players) details including sport specific details (metadata properties)" }, { "info": { "name": "Retrieve rounds in which the Player will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/players/:id/rounds", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (players) ID to return details for" } ] }, "docs": "Returns the rounds in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve seasons in which the Player will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/players/:id/seasons", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (players) ID to return details for" } ] }, "docs": "Returns the seasons in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS model" } ] }, { "info": { "name": "competitors/tbds", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors (TBD) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/tbds", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" } ] }, "docs": "Returns competitors (TBD) wrapped inside a HATEOAS model" }, { "info": { "name": "Create new TBD competitor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/competitors/tbds", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new TBD competitor" }, { "info": { "name": "Update existing TBD", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/competitors/tbds", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing TBD" }, { "info": { "name": "Retrieve competitors (TBD) details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/tbds/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors (TBD) ID to return details for" } ] }, "docs": "Returns competitors (TBD) details including sport specific details (metadata properties)" } ] }, { "info": { "name": "competitors/teams", "type": "folder" }, "items": [ { "info": { "name": "Retrieve competitors (teams) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/teams", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)" } ] }, "docs": "Returns competitors (teams) wrapped inside a HATEOAS model" }, { "info": { "name": "Create new team", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/competitors/teams", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new team" }, { "info": { "name": "Update existing team", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/competitors/teams", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing team" }, { "info": { "name": "Retrieve competitors (teams) details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/teams/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single competitors (teams) ID to return details for" } ] }, "docs": "Returns competitors (teams) details including sport specific details (metadata properties)" }, { "info": { "name": "Retrieve rounds in which the Team will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/teams/:id/rounds", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (teams) ID to return details for" } ] }, "docs": "Returns the rounds in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve seasons in which the Team will take part by Team ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/competitors/teams/:id/seasons", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single competitors (teams) ID to return details for" } ] }, "docs": "Returns the seasons in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS model" } ] }, { "info": { "name": "fixtures", "type": "folder" }, "items": [ { "info": { "name": "Retrieve fixtures by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "deleted", "value": "", "type": "query", "description": "This field specifies whether to include deleted, not deleted, or both. Possible values: False, True, or All." }, { "name": "eventTypes", "value": "", "type": "query", "description": "This field specifies the event type to be returned (Match, SeasonOutright, PartialOutright, AggregateEvent). By default, if not provided, 'Match' is returned. Multiple types can be combined in a single request, separated by commas." }, { "name": "withCompetitors", "value": "", "type": "query", "description": "This field specifies whether when set to true to return fixtures without any TBD competitors or false for all fixtures" }, { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)" } ] }, "docs": "Returns fixtures wrapped inside a HATEOAS model" }, { "info": { "name": "Create new fixture", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/fixtures", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new fixture" }, { "info": { "name": "Update existing fixture", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/fixtures", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing fixture" }, { "info": { "name": "Patch existing fixture", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/fixtures", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Patch existing fixture" }, { "info": { "name": "Retrieve fixtures refdata by filter. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures/refdata", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)" } ] }, "docs": "Returns fixtures refdata wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve fixtures details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "deleted", "value": "", "type": "query", "description": "This field specifies whether to include deleted, not deleted, or both. Possible values: False, True, or All." }, { "name": "eventType", "value": "", "type": "query", "description": "The field specifies the type of event to return (Match, SeasonOutright, PartialOutright, AggregateEvent). If not provided, the search defaults to fixtures of type 'Match'." }, { "name": "id", "value": "", "type": "path", "description": "Single fixtures ID to return details for" } ] }, "docs": "Returns fixtures details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing fixture", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/fixtures/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing fixture" }, { "info": { "name": "Retrieve whole fixture's lineups by fixture ID for both teams ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures/:id/lineups", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single fixture ID to return lineups for" } ] }, "docs": "Lineup availability may vary depending on the sport and specific fixture. In certain sports, lineups are provided only for selected competitions only. When lineup data is not available, the API will return an empty response." }, { "info": { "name": "Retrieve fixture's officials by fixture ID. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fixtures/:id/officials", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed." }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators." }, { "name": "id", "value": "", "type": "path", "description": "Single fixture ID to return officials for" } ] }, "docs": "Returns fixture's officials wrapped inside a HATEOAS model" }, { "info": { "name": "Adds new official to the fixture", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/fixtures/:id/officials", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single fixture ID to create official for" } ] }, "docs": "Adds new official to the fixture" }, { "info": { "name": "Update existing fixture official", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/fixtures/:id/officials", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single fixture ID to update official for" } ] }, "docs": "Update existing fixture official" }, { "info": { "name": "Removes official added to fixture", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/fixtures/:id/officials/:personId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "personId", "value": "", "type": "path" } ] }, "docs": "Removes official added to fixture" } ] }, { "info": { "name": "groups", "type": "folder" }, "items": [ { "info": { "name": "Retrieve groups by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, seasonId, competitionId, sportId, type)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, seasonId, competitionId, sportId, type)" } ] }, "docs": "Returns groups wrapped inside a HATEOAS model" }, { "info": { "name": "Create new group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/groups", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new group" }, { "info": { "name": "Update existing group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/groups", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing group" }, { "info": { "name": "Retrieve groups details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single groups ID to return details for" } ] }, "docs": "Returns groups details including sport specific details (metadata properties)" } ] }, { "info": { "name": "rounds", "type": "folder" }, "items": [ { "info": { "name": "Delete existing round", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/groups/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing round" }, { "info": { "name": "Retrieve rounds by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rounds", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, seasonId, competitionId, sportId, type)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, seasonId, competitionId, sportId, type)" } ] }, "docs": "Returns rounds wrapped inside a HATEOAS model" }, { "info": { "name": "Create new round", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rounds", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new round" }, { "info": { "name": "Update existing round", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rounds", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing round" }, { "info": { "name": "Patch existing round", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rounds", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Patch existing round" }, { "info": { "name": "Retrieve rounds details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rounds/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single rounds ID to return details for" } ] }, "docs": "Returns rounds details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing round", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rounds/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing round" }, { "info": { "name": "Retrieve round competitors by Round ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rounds/:id/competitors", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single rounds ID to return details for" } ] }, "docs": "Returns the competitors which will take part in the round related to the GSS Round Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Adds new competitor to the round", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rounds/:id/competitors", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Adds new competitor to the round" }, { "info": { "name": "Removes competitor added to round", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rounds/:id/competitors/:competitorId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "competitorId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes competitor added to round" } ] }, { "info": { "name": "ingestion", "type": "folder" }, "items": [ { "info": { "name": "Ingest competition data for update or create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ingestion/competitions", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Ingest competition data for update or create" }, { "info": { "name": "Search for ingestion proposals by competition Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/competitions/searchById", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "onlyOwned", "value": "", "type": "query", "description": "Indicates whether proposals from other sources should be included." }, { "name": "ids", "value": "", "type": "query", "description": "A list of competition Ids" } ] }, "docs": "Search for ingestion proposals by competition Id." }, { "info": { "name": "Search for ingestion proposals by source entity Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/competitions/searchBySourceEntityId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "sourceEntityIds", "value": "", "type": "query", "description": "A list of source entity Ids" }, { "name": "source", "value": "", "type": "query", "description": "The source that ingested the proposals." } ] }, "docs": "Search for ingestion proposals by source entity Id." }, { "info": { "name": "Tracking the progress of the asynchronous execution.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/competitions/:trackingRequestId/status", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "trackingRequestId", "value": "", "type": "path", "description": "GUID returned from an ingestion request" } ] }, "docs": "Returns the current state of the ingestion request" }, { "info": { "name": "Ingest fixture data for update or create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ingestion/fixtures", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Ingesting competitors requires indicating the competitor type. There are 3 options: Specify competitionType on competition level. Specify competitorType on competitor level. Include one of the teamPropertiesModel/playerPropertiesModel/doublesPropertiesModel fields on a competitor level." }, { "info": { "name": "Patch existing fixture request. Currently support only lineups patch by sourceEntityId of the fixture.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ingestion/fixtures", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Patch existing fixture request. Currently support only lineups patch by sourceEntityId of the fixture." }, { "info": { "name": "Search for ingestion proposals by fixture Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/fixtures/searchById", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "onlyOwned", "value": "", "type": "query", "description": "Indicates whether proposals from other sources should be included." }, { "name": "ids", "value": "", "type": "query", "description": "A list of fixture Ids" } ] }, "docs": "Search for ingestion proposals by fixture Id." }, { "info": { "name": "Search for ingestion proposals by source entity Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/fixtures/searchBySourceEntityId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "sourceEntityIds", "value": "", "type": "query", "description": "A list of source entity Ids" }, { "name": "source", "value": "", "type": "query", "description": "The source that ingested the proposals." } ] }, "docs": "Search for ingestion proposals by source entity Id." }, { "info": { "name": "Tracking the progress of the asynchronous execution.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/fixtures/:trackingRequestId/status", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "trackingRequestId", "value": "", "type": "path", "description": "GUID returned from an ingestion request" } ] }, "docs": "Returns the current state of the ingestion request" }, { "info": { "name": "Ingest team squad players data for update or create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ingestion/squads", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Ingest team squad players data for update or create" }, { "info": { "name": "Search for ingestion proposals by squad Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/squads/searchById", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "onlyOwned", "value": "", "type": "query", "description": "Indicates whether proposals from other sources should be included." }, { "name": "ids", "value": "", "type": "query", "description": "A list of squad Ids" } ] }, "docs": "Search for ingestion proposals by squad Id." }, { "info": { "name": "Search for ingestion proposals by source entity Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/squads/searchBySourceEntityId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "sourceEntityIds", "value": "", "type": "query", "description": "A list of source entity Ids" }, { "name": "source", "value": "", "type": "query", "description": "The source that ingested the proposals." } ] }, "docs": "Search for ingestion proposals by source entity Id." }, { "info": { "name": "Tracking the progress of the asynchronous execution.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ingestion/squads/:trackingRequestId/status", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "trackingRequestId", "value": "", "type": "path", "description": "GUID returned from an ingestion request" } ] }, "docs": "Returns the current state of the ingestion request" } ] }, { "info": { "name": "localities", "type": "folder" }, "items": [ { "info": { "name": "Retrieve localities (old regions) by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/localities", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, localityType)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, localityType)" } ] }, "docs": "Returns localities (old regions) wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve locality details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/localities/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single locality ID to return details for" } ] }, "docs": "Returns locality details by ID" } ] }, { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "Retrieve organizations data. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)" } ] }, "docs": "Returns organizations wrapped inside a HATEOAS model" }, { "info": { "name": "Create new organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new organization" }, { "info": { "name": "Update existing organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organizations", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing organization" }, { "info": { "name": "Retrieve organization details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single organization ID to return details for" } ] }, "docs": "Returns organization details." }, { "info": { "name": "Delete existing organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing organization" } ] }, { "info": { "name": "persons", "type": "folder" }, "items": [ { "info": { "name": "Retrieve persons by ID/s. MAX 200 per page. (Not available yet)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/persons", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)" } ] }, "docs": "Returns persons wrapped inside a HATEOAS model" }, { "info": { "name": "Create new person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/persons", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new person" }, { "info": { "name": "Update existing person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/persons", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing person" }, { "info": { "name": "Retrieve persons which were in the past or are currently coaches by ID/s. MAX 200 per page. (Not available yet)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/persons/coaches", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)" } ] }, "docs": "Returns persons wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve persons details by ID. (not available yet)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/persons/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single person ID to return details for" } ] }, "docs": "Returns persons details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/persons/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing person" }, { "info": { "name": "Retrieve person's officials by person ID. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/persons/:id/officials", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed." }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators." }, { "name": "id", "value": "", "type": "path", "description": "Single person ID to return officials for" } ] }, "docs": "Returns person's officials wrapped inside a HATEOAS model" } ] }, { "info": { "name": "seasons", "type": "folder" }, "items": [ { "info": { "name": "Retrieve seasons by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/seasons", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, competitionId, sportId, genderType, localityId)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, competitionId, sportId, genderType, localityId)" } ] }, "docs": "Returns seasons wrapped inside a HATEOAS model" }, { "info": { "name": "Create new season", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/seasons", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new season" }, { "info": { "name": "Update existing season", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/seasons", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing season" }, { "info": { "name": "Patch existing season", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/seasons", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Patch existing season" }, { "info": { "name": "Retrieve seasons details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/seasons/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single season ID to return details for" } ] }, "docs": "Returns seasons details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing season", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/seasons/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing season" }, { "info": { "name": "Retrieve season competitors by Season ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/seasons/:id/competitors", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, competitortype)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, competitortype, isactive (default = true))" }, { "name": "id", "value": "", "type": "path", "description": "Single season ID to return details for" } ] }, "docs": "Returns the competitors which will take part in the season related to the GSS Season Id in the path, wrapped inside a HATEOAS model" }, { "info": { "name": "Adds new competitor to the season", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/seasons/:id/competitors", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Adds new competitor to the season" }, { "info": { "name": "Removes competitor added to season", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/seasons/:id/competitors/:competitorId", "headers": [ { "name": "gs-fixtures-api-sub-source", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "competitorId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes competitor added to season" } ] }, { "info": { "name": "sourcerequests", "type": "folder" }, "items": [ { "info": { "name": "Retrieves info about the status of a Source Request, given its Request Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sourcerequests/:requestId/status", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "requestId", "value": "", "type": "path" } ] }, "docs": "Retrieves info about the status of a Source Request, given its Request Id." } ] }, { "info": { "name": "sports", "type": "folder" }, "items": [ { "info": { "name": "Retrieve sports by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sports", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)" } ] }, "docs": "Returns sports wrapped inside a HATEOAS model" }, { "info": { "name": "Retrieve allowed properties per entity type name and per sport.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sports/:id/:entityType/metadata", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "entityType", "value": "", "type": "path", "description": "Entity type is the name of the entity for which the allowed properties will be retrieved. Entity types: competition, competitor, contract, fixture, round, season, venue, fixtureperson, player, team" }, { "name": "id", "value": "", "type": "path", "description": "The sport for which the allowed properties will be retrieved." } ] }, "docs": "Retrieve allowed properties per entity type name and per sport." } ] }, { "info": { "name": "venues", "type": "folder" }, "items": [ { "info": { "name": "Retrieve venues by ID/s. MAX 200 per page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/venues", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The number of page to be returned. The default value is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "The size of the page to be returned. The default value is 10." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)" }, { "name": "filter", "value": "", "type": "query", "description": "The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)" } ] }, "docs": "Returns venues wrapped inside a HATEOAS model" }, { "info": { "name": "Create new venue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/venues", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Create new venue" }, { "info": { "name": "Update existing venue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/venues", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ] }, "docs": "Update existing venue" }, { "info": { "name": "Retrieve venues details by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/venues/:id", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Single venues ID to return details for" } ] }, "docs": "Returns venues details including sport specific details (metadata properties)" }, { "info": { "name": "Delete existing venue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/venues/:id", "headers": [ { "name": "x-api-key", "value": "" }, { "name": "gs-fixtures-api-sub-source", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete existing venue" } ] } ], "bundled": true }