TopX Guide
The TopX APIs is designed to allow partners to access the SIS ecosystem, to easily build third-party applications and extensions. All our APIs are RESTful, accepting GET and POST methods and return JSON or XML depending on what is configured in the request. To get started using our APIS, the developer will need to register with our partner program. Our APIs provide help pages which detail the available methods which the developer can use as well as example requests and responses.
Format
Our APIs allow for the developer to choose in which format (JSON or XML) they want to send the request and receive in the response. You specify the request and response types by using the http headers in the details tab.
Request Format:
Content-Type: application/json
Content-Type: application/xml
Response Format:
Accept: application/json
Accept: application/xml
Responses
Our responses contain status information such as whether the request succeeded or failed and a collection of error and warning messages that occurred as a part of the request. For brevity, the responses in the rest of the documentation will omit this information. We have provided examples of this base response in both XML and JSON format. We have also provided the status values inside of the base response for reference purposes.
<Messages xmlns="http://schemas.datacontract.org/2004/07/TSSystem">
<RuntimeMessage>
<Code>String</Code>
<Message>String</Message>
<Scope>Integer</Scope>
<Type>Integer</Type>
</RuntimeMessage>
</Messages>
<Status xmlns="http://schemas.datacontract.org/2004/07/TSSystem">
{
"Messages":[{
"Code":"String",
"Message":"String",
"Scope":Integer,
"Type":Integer
}],
"Status":Integer
}
Defined Values:
Message.Scope: {0:Undefined}, {1:FriendlyError}, {2:SystemError}
Message.Type: {0:Exception}, {1:Runtime}, {2:Validation}
Status: {0:Undefined}, {1:Success}, {4:Error}, {8:Warning}