getProfileContract.md

Back

Get Profile

Retrieve Profile data for a user specified by ProfileID.

URL : api/v1/profiles/{id}

Method : GET

Auth required : NO

Permissions required : NO

Data example ID parameter required. No payload required.

Success Response

Condition : If profile exists

Code : 200 OK

Content example

{
	"firstName" : "Trace",
	"lastName" : "Ohrt",
	"address" : {
		"street": "1600 Pennsylvania Ave NW",
		"city": "Washington",
		"state" : "DC",
		"zipcode" : "20500"
	},
	"email" : "teohrt18@gmail.com"
}

Error Responses

Condition : If profile does not exist

Code : 404 NOT FOUND

Content :

{
    "status": "Not Found",
    "message": "Profile not found",
    "error": "Could not find profile associated with: 333"
}

Or

Condition : If the server chokes on something

Code : 500 INTERNAL SERVER ERROR

Content

{
    "status": "Internal Server Error",
    "message": "Get profile failed",
    "error": "RequestError: send request failed\ncaused by: Post http://localhost:8000/: dial tcp [::1]:8000: connect: connection refused"
}