...
This guide assumes basic familiarity with USPS. It also assumes the reader is familiar with SOAP, XML and other related technologies.
| Info |
|---|
This documentation applies to both the Classic and Redesign versions of USPS. Except as noted in the document the Redesign and Classic API's of the SOAP services are compatible. |
Glossary
ITC, Information Technology Centers are regional data processing centers that provide computer services to member school districts. Among the services ITCs provide is hosting of the USPS application for school districts.
...
District Database Identification
For Classic USPS a single SOAP service endpoint is used to access all district databases at an ITC. Each unique database is identified by a “district code” "district code" or IRN. Some ITCs ITC's also support the use of NCES codes to identify district databases. After a SOAP client authenticates with the SOAP service, it must declare the district database on which it intends to operate. Alternatively, the SOAP client may query the service for the databases the user has access to and allow the user to select the district code.
...
For Redesign USAS, a separate endpoint is used for each district. In Redesign implementations of the SOAP service, the setDistrictAccess operation is a NOOP and is not necessary.
SOAP Service Endpoints
Each ITC that supports the USPS Classic USAS SOAP service will provide one or more “SOAP endpoint” URLs URL's for accessing the service for their districts. In most cases, a single endpoint will be used for all districts hosted by a given ITC Site. However, in some cases, an ITC may provide a different endpoint for specific districts.
Most ITCs For Redesign USAS SOAP, a separate endpoint will be provided for each school district.
ITC's will provide an HTTPS (SSL) end-point can be used to encrypt SOAP messages on the wire. Developers are encouraged required to use HTTPS when available. Each ITC decides whether HTTPS is available or required and may have other local security policies regarding from what networks SOAP connections are availablefor production instances.
Authentication and Authorization
...
- Invoke _login _operation with credentials for an account on the USPS server
- Optional: Invoke _getDistrictList _to return a list of districts the user can access
- Optional for Redesign: Invoke _setDistrictAccess _to bind the session to a given district database
...