getDirectoryContacts

Returns a list of Contacts available for viewing by this User. Contacts returned can either be: 1.) Contacts related to an ACTIVE Connection who have consented to any Consents required by the Directory 2.) Contacts with no Connection and therefore can never consent as they can't login

Request

GET /rest/smartdirectory/{smartDirectoryUUID}/directoryContacts

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

smartDirectoryUUID - path parameter. UUID of the Smart Directory as set up in SAM.

Response

200 OK

{
    "contacts" : [
        {
            "contactId": 5,   
            "fields": [
                 {
                    "id": 35,
                    "name": "contactEmail1",
                    "value": "test@test.com",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 1
                },
                {
                    "id": 36,
                    "name": "contactFirstname",
                    "value": "Not Invited",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 2
                },
                {
                    "id": 33,
                    "name": "contactLastname",
                    "value": "Not Invited",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 3
                },
            ]
        },
        {
            "contactId": 5,
            "fields": [
                {
                    "id": 35,
                    "name": "contactEmail1",
                    "value": "aaron.mcmullen@hypermedia.com.au",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 1
                },
                {
                    "id": 36,
                    "name": "contactFirstname",
                    "value": "Joe",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 2
                },
                {
                    "id": 33,
                    "name": "contactLastname",
                    "value": "Bloggs",
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 3
                },
                {
                    "id": 37,
                    "name": "gender",
                    "value": null,
                    "hide": "N",
                    "type": "text",
                    "isAddressField" : "N",
                    "order" : 4
                }
            ],
            "addresses": [
                {
                    "uuid": null,
                    "type": "Work",
                    "typeCode": "W",
                    "name": "Address 1 Name",
                    "street": "Address 1 Street",
                    "city": "Address 1 City",
                    "suburb": null,
                    "stateCode": "AU-NSW",
                    "state": "New South Wales",
                    "postcode": "2000",
                    "countryCode": "AU",
                    "country": "AUSTRALIA",
                    "email": null,
                    "phone": "1234567",
                    "fax": "1234567",
                    "mobile": "1234567",
                    "department": "Address 1 Department",
                    "division": null,
                    "jobTitle": "Address 1 Job Title"
                }
            ]
        }
    ]
}

Errors

Exception	Description
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSInvalidParameterException	See Error Definitions
WSSmartDirectoryNotFoundException	See Error Definitions
WSSmartDirectoryServiceExceptio	See Error Definitions
WSSmartDirectoryNotEnabledForCompanyException	See Error Definitions
WSUserContactNotFoundException	See Error Definitions
WSUserNotInSmartDirectoryException	See Error Definitions