Get Address

Get Address API will fetch the address of the requested user.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL

GET https://{hostname}/auth/realms/{tenantId}/address/{userName}

note

Digitanium support for this API will be provided on request.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameters fields are required.

Request body

No Request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Object	The user info object.
addressID	String	Define the addressID given for a particular user.
addressType	String	Define the place of the address.
addressTitle	String	Define the title given to the respective address.
city	String	Define the city given for the address.
cityCode	String	Define the cityCode given for the location.
addressDetails	String	Describe the details related to the address.
directions	String	Provide the direction for the address.
district	String	Define the district the address is located.
districtCode	String	Define the districtCode the address is located.
firstName	String	firstName of the user.
lastName	String	lastName of the user.
defaultAddress	Boolean	The configured default address will be taken, if true.
addressTitle	String	Define the title given to the respective address.
postalCode	String	Define the postalCode of the given address.
town	String	Define the town the address is located.
townCode	String	Define the townCode the address is located.

Sample Response

{
    "message": "Address info fetched successfully",
    "status": "Success",
    "subSystem": 5,
    "data": [
        {
            "addressID": "5538279e-f35c-42fc-8d7d-0036bd01964e",
            "addressType": "Home",
            "addressTitle": "Home address",
            "city": "scotland",
            "cityCode": "625531",
            "addressDetails": "addressDetails",
            "direction": "",
            "district": "glasgow",
            "districtCode": "123456",
            "firstName": "sash",
            "lastName": "mark",
            "defaultAddress": "true",
            "postalCode": "654321",
            "town": "hometown",
            "townCode": "625521"
        },
        {
            "addressID": "0a7373c0-a934-49bc-be76-8d80bdf0f45c",
            "addressType": "Home",
            "addressTitle": "Home address",
            "city": "scotland",
            "cityCode": "625001",
            "addressDetails": "addressDetails",
            "direction": "",
            "district": "Tayside",
            "districtCode": "123456",
            "firstName": "jake",
            "lastName": "eve",
            "defaultAddress": "false",
            "postalCode": "654321",
            "town": "hometown",
            "townCode": "625521"
        }
] 

Response Status Information

Status Code	Status	Message
200	OK	Address info fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist
404	NOT_FOUND	Address not found