Interface - Revision2

POST

/sendInvoice

Sends UBL invoice via email to specified addresses. Returns a communication report informing user of success/errors: if unsuccessful, the report has errors (eg. email address invalid, connection not etablished etc.). It also includes address, client, time/date. It will be readable for humans to understand. Should also save a record of the transaction

Header:

deliveryAddresses (List<String>)

Body:

invoice (UBL 2.1 XML)

communicationReport (JSON)

{

"xmlFound": (boolean)

"xmlRightSize": (boolean),

"emailValid": (boolean)

"connectedToMail": (boolean),

"sentMail": (boolean),

"timeTaken": (integer)

}

400 errors:

• Invalid/Missing email address

• No XML invoice

413 errors:

• XML invoice >10MB

GET

/HealthCheck

Health check endpoint that indicates the aliveness of this service. Gives information about success, server up time, number of transactions and current version.

None

{

alive: (boolean)

serverUpTime: (Integer)

numTransactions: (Integer)

numSuccess: (Integer)

currentVersion: (String)

}

None

GET

/newsession

Returns a new token for user to use for this session. Tokens will expire after a set amount of inactivity.

username

password

{

token

}

None

POST

/CreateNewUser

allows a new user to be created for

email

username

password

name

200 on success

500 on fail