How to access Mobiess API

This article explains what functionality is available.

The REST endpoint for the API is https://customer.mobiess.com/svc and all future calls to the API must be made to this endpoint.

Accessing the endpoint https://customer.mobiess.com/svc via a web browser will redirect to a metadata page which will show the available functions and the expected arguments required to call the method.

To authenticate make a POST request to https://customer.mobiess.com/svc/Authenticate with the following JSON body:

{
	"provider":"credentials",
	"UserName":"--username from Mobiess--",
	"Password":"password"
}

You will also need to include your Customer ID as a header value for the request:

customerId: "ExxxxEC1-xxxx-41E0-xxxx-89176xxxxC52"

You will receive a response from the server with credentials if the login was successful:

{
    "UserId":"7xxxa6df-xxxx-4e19-xxxx-006xxxxxa119",
    "SessionId":"PUM9x6XXXXXXXm1euy",
    "UserName":"[email protected]",
    "DisplayName":"Bob Jones"
}

All future requests will need to use the BearerToken returned in future calls to the API.

To add a new Sub System Type to Mobiess use the following endpoint https://customer.mobiess.com/svc/api/Query/SubSystemType

POSTing the following:

{
    "code": "EC1",
    "isGrouped": "True",
    "name": "Example Code",
    "showWarning": "True"
}

ensuring the x-ss-id header has been added from the initial Authenticate request:

x-ss-id: "PUM9x6XXXXXXXm1euy"

Will create a new Sub System Type in Mobiess.

{
    "Result": {
        "Id": "d3f3xxxxf91a40xxxx47965xxxxf66c5",
        "Code": "Example Code",
        "IsGrouped": true,
        "Name": "Example",
        "ShowWarning": true,
        "__CustomerId": "ExxxxEC1xxxx41E0xxxx89176xxxxC52"
    },
    "Count": 1
}

This API is subject to change although we do not intend to change the signature of any existing web methods that have been made available.