Web Service Description: UspsEmisServices

Contents


This WSDL describes the USPS/EMIS web services interface to the OECN State Software USPS (Uniform School Payroll System). This service is tailored to provide EMIS related data in bullk.


Service Summary: Service: UspsEmisServices

Port name: USPSEMISWS
Endpoint URL: http://localhost:8081/services/USPSEMISWS
Binding: impl:USPSEMISSoapBinding


Namespaces:

PrefixNamespace
[Default]http://xml.ssdt.nwoca.org/uspsemis/ws
apachesoaphttp://xml.apache.org/xml-soap
implhttp://xml.ssdt.nwoca.org/uspsemis/ws
intfhttp://xml.ssdt.nwoca.org/uspsmemis/ws
oecnrpchttp://xml.ssdt.nwoca.org/OECN-RPC/10
uspshttp://xml.ssdt.nwoca.org/USPS/42
wsdlhttp://schemas.xmlsoap.org/wsdl/
wsdlsoaphttp://schemas.xmlsoap.org/wsdl/soap/
xmlhttp://www.w3.org/XML/1998/namespace
xsdhttp://www.w3.org/2001/XMLSchema
xsihttp://www.w3.org/2001/XMLSchema-instance

Imported Schemas

NamespaceLocation
http://xml.ssdt.nwoca.org/USPS/42http://devel.ssdt.nwoca.org/uspssoap/usps-42.xsd

Port Type: UspsEmisService

Operations:
OperationDescription
close Closes the specified sessionId and releases the session resources from the SOAP server.
connect Submits an connetion request to the server.
getDistrictInfo Returns information about the District including name, address, fiscal period, IRN, etc.
retrieveEmployees Returns Employees from USPS.
retrievePositions Returns Positions from USPS.

Operations Detail

Operation: close

Closes the specified sessionId and releases the session resources from the SOAP server. The client must not make subsequent calls using the sessionId after the session has been logged out.

InputcloseRequest
OutputcloseResponse

Operation: connect

Submits an connetion request to the server. The client must provide a uername password and "district" to conect to. The district may be a district envionment code or IRN.

InputconnectRequest
OutputconnectResponse

Operation: getDistrictInfo

Returns information about the District including name, address, fiscal period, IRN, etc.

InputgetDistrictInfoRequest
OutputgetDistrictInfoResponse

Operation: retrieveEmployees

Returns Employees from USPS. Each invocation of returns the next set of Employee elements up to 'maxReturn'. The client should continue to invoke the operation until all Employee elements are returned. When all Employee elements have been returned the final invocation will return an empty Employees element.

InputretrieveEmployeesRequest
OutputretrieveEmployeesResponse

Operation: retrievePositions

Returns Positions from USPS. Each invocation of returns the next set of Position elements up to 'maxReturn'. The client should continue to invoke the operation until all Employee elements are returned. When all Position elements have been returned the final invocation will return an empty Positions element.

InputretrievePositionsRequest
OutputretrievePositionsResponse

Messsages

MessageParameter
closeRequest [http://xml.ssdt.nwoca.org/uspsemis/ws]:close
closeResponse [http://xml.ssdt.nwoca.org/uspsemis/ws]:closeResponse
connectRequest [http://xml.ssdt.nwoca.org/uspsemis/ws]:connect
connectResponse [http://xml.ssdt.nwoca.org/uspsemis/ws]:connectResponse
getDistrictInfoRequest [http://xml.ssdt.nwoca.org/uspsemis/ws]:getDistrictInfo
getDistrictInfoResponse [http://xml.ssdt.nwoca.org/uspsemis/ws]:getDistrictInfoResponse
retrieveEmployeesRequest [http://xml.ssdt.nwoca.org/uspsemis/ws]:retrieveEmployees
retrieveEmployeesResponse [http://xml.ssdt.nwoca.org/uspsemis/ws]:retrieveEmployeesResponse
retrievePositionsRequest [http://xml.ssdt.nwoca.org/uspsemis/ws]:retrievePositions
retrievePositionsResponse [http://xml.ssdt.nwoca.org/uspsemis/ws]:retrievePositionsResponse

Elements

[http://xml.ssdt.nwoca.org/uspsemis/ws]:close

[http://xml.ssdt.nwoca.org/uspsemis/ws]:closeResponse

[http://xml.ssdt.nwoca.org/uspsemis/ws]:connect

[http://xml.ssdt.nwoca.org/uspsemis/ws]:connectResponse

[http://xml.ssdt.nwoca.org/uspsemis/ws]:getDistrictInfo

[http://xml.ssdt.nwoca.org/uspsemis/ws]:getDistrictInfoResponse

[http://xml.ssdt.nwoca.org/uspsemis/ws]:retrieveEmployees

[http://xml.ssdt.nwoca.org/uspsemis/ws]:retrieveEmployeesResponse

[http://xml.ssdt.nwoca.org/uspsemis/ws]:retrievePositions

[http://xml.ssdt.nwoca.org/uspsemis/ws]:retrievePositionsResponse

Types



Generated by ssdt wsd2html 0.2-0