JSON Web Token must be passed in via header on every request.
This token is generated automatically on first run and can be found in Portal Setup under the Portal Options tab.

Table of Contents

1 PortalController | URL: /portal/
- 1.1 getHomePageResults – POST/GET
2 UserController | URL: /user/

PortalController | URL: /portal/

getHomePageResults – POST/GET

Field	Req?	Accepted values	Description	Example
Input
linkedLabsClientList	Y	List of whole numbers		[695114,694896]
linkedLabsSiteList	Y	List of whole numbers		[1]
clientType1ID	Y	Whole number		13
clientType2ID	Y	Whole number		8
additionalQueryEnabled		Boolean		false
additionalQuery		Text
accountClientsList	Y	List of Clients in JSON format		[{"name":"Andrew Handyman","id":695114,"displayPayment":true,"name-id":"Andrew Handyman - 695114"}]
portalLabsAccountingViewOption		Text: ALL\|INVOICE_ONLY		ALL
linkedHospitalClientList	Y	List of whole numbers		[231112]
Output
Field		Value types	Description	Example
recentAccessions		List of Lab Accessions		See example in Lab Accessions
recentLabsInvoices		Lab Invoice Overview		See example in Lab Invoice Overview
recentOwnerEpisodes		List of Hospital Episodes		See example in Hospital Episodes
appointmentOwnerEpisodes		List of Hospital Episodes		See example in Hospital Episodes
hospitalReceipts		Hospital Receipt Overview		See example in Hospital Receipt Overview
accountHospitalClientsList		List of whole numbers		[231112,56321]
hospitalClientID		Whole number		231112
hospitalClientName		Text		231112 – Nung Stables
Examples
Example parameter string (must be URL encoded when sent to VetView)	?additionalQueryEnabled=false&additionalQuery=&clientType1ID=8&clientType2ID=10&linkedLabsClientList=[695114,694896]&linkedLabsSiteList=[1]&accountClientsList=[{"name":"Drew Handyman","id":695114,"displayPayment":true,"name-id":"Drew Handyman - 695114"}portalLabsAccountingViewOption=null&linkedHospitalClientList=[231112]
Example return

UserController | URL: /user/

getPortalUserDetails – POST/GET

Field	Req?	Accepted values	Description	Example
Input
username	Y	Text		AbeNung
password	Y	Text of hashed password		eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM
Output
Field		Value types	Description	Example
portalUser		Portal User		See example in Portal User
sections		List of
userIsAuthenticated		Boolean		true
Examples
Example parameter string (must be URL encoded when sent to VetView)	?username=AbeNung&password=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM
Example return

getPortalUserPasswordReqs – POST/GET

Field	Req?	Accepted values	Description	Example
Input
No input accepted
Output
Field		Value types	Description	Example
containsUsername		Boolean		false
requireNumber		Boolean		true
requireSpecialChar		Boolean		false
requireUppercaseLetter		Boolean		true
minLength		Whole number		0
maxLength		Whole Number		32
Examples
Example parameter string (must be URL encoded when sent to VetView)	Accepts no parameters
Example return	requirements={containsUsername=false, requireNumber=true, requireSpecialChar=false, requireUppercaseLetter=false, minLength=0, maxLength=32}

changePassword – POST only

Field	Req?	Accepted values	Description	Example
Input
username	Y	Text		fakeUser
currentPassword	Y	Text of hashed password		eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM
newPassword	Y	Text of hashed password		eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM
Output
Field		Value types	Description	Example
success		Text		Password Changed Successfully
Examples
Example parameter string (must be URL encoded when sent to VetView)	?username=fakeUser&currentPassword= eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM &newPassword= eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJibGFoNDgwNiIsImlzcyI6ImF1dGgwIn0.xs8EuTtpki55ZjW22L71j2EY2LoHr0PA3HmLBShHEWM
Example return	{success=Password Changed Successfully}

resetPortalPassword – POST

Field	Req?	Accepted values	Description	Example
Input
email	Y	Text		fakeemail@domain.com
Output
Field		Value types	Description	Example
success		Text		Password successfully reset. Check your email for further instructions.
Examples
Example parameter string (must be URL encoded when sent to VetView)	?email=fakeemail@domain.com
Example return	{Success=Password successfully reset. Check your email for further instructions.}

registerPortalUser – POST

Field	Req?	Accepted values	Description	Example
Input
newPortalUser	Y	Text/JSON		fakeemail@domain.com
Output
Field		Value types	Description	Example
success		Text		Password successfully reset. Check your email for further instructions.
Examples
Example parameter string (must be URL encoded when sent to VetView)	?email=fakeemail@domain.com
Example return	{Success=Password successfully reset. Check your email for further instructions.}

Technical Documentation

Web Services Calls: Common / Security