GameCenter Web Api

<back to all web services

GetAllSchools

Get school information. Must filter by either part of a name or by state ID, which can be retrieved from GetAllStates. Accept-Encoding compression header recommended. Paging parameters Page and PageSize are recommended; alternatively count and offset can be used, but not at the same time as Page and PageSize; limits to a maximum of 100 schools per page.

The following routes are available for this service:
GET/schools
Parameters:
NameParameterData TypeRequiredDescription
ModifiedAfterpathstringNoOptional, but HIGHLY recommended; must be in UTC or included an appropriate time zone offset; format: YYYY-MM-DDTHH:mm:ss+ZZ
CountpathstringNodeprecated in favor of PageSize; how many results to return per page
PagepathstringNoone-based page, based on how big each page is (via PageSize)
PageSizepathstringNohow many results to return per page; may be limited if too many are requested—ensure subsequent pages never request a bigger PageSize than is returned in a previous page (unless this is the last or after the last page, in other words, zero results were returned) to ensure results are not accidentally skipped
OffsetpathstringNodeprecated in favor of Page; how many results to skip

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetAllSchools HTTP/1.1 
Host: api.digitalscout.com 
Content-Type: application/xml
Content-Length: length

<GetAllSchools xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models">
  <AuthToken xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">String</AuthToken>
  <Version xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">String</Version>
  <Count xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">0</Count>
  <ModifiedAfter xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">String</ModifiedAfter>
  <Offset xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">0</Offset>
  <Page xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">0</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models.Abstractions">0</PageSize>
  <Name>String</Name>
  <StateId>0</StateId>
</GetAllSchools>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAllSchoolsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GameCenter.Api.Models">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Schools>
    <SchoolResponseModel>
      <Conference>String</Conference>
      <CreatedOn>String</CreatedOn>
      <Description>String</Description>
      <SchoolId>0</SchoolId>
      <SchoolMascot>String</SchoolMascot>
      <SchoolName>String</SchoolName>
      <State>String</State>
      <UpdatedOn>String</UpdatedOn>
    </SchoolResponseModel>
  </Schools>
</GetAllSchoolsResponse>