Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a list of directory site contacts, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.directorySiteContacts.list
.
- type DirectorySiteContactsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySiteContacts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" DirectorySiteContactsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySiteContactsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySiteContactsListResponse))))))))))))
- directorySiteContactsList :: Int64 -> DirectorySiteContactsList
- data DirectorySiteContactsList
- dsclSearchString :: Lens' DirectorySiteContactsList (Maybe Text)
- dsclIds :: Lens' DirectorySiteContactsList [Int64]
- dsclProFileId :: Lens' DirectorySiteContactsList Int64
- dsclDirectorySiteIds :: Lens' DirectorySiteContactsList [Int64]
- dsclSortOrder :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortOrder)
- dsclPageToken :: Lens' DirectorySiteContactsList (Maybe Text)
- dsclSortField :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortField)
- dsclMaxResults :: Lens' DirectorySiteContactsList (Maybe Int32)
REST Resource
type DirectorySiteContactsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySiteContacts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" DirectorySiteContactsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySiteContactsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySiteContactsListResponse)))))))))))) Source #
A resource alias for dfareporting.directorySiteContacts.list
method which the
DirectorySiteContactsList
request conforms to.
Creating a Request
directorySiteContactsList Source #
Creates a value of DirectorySiteContactsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DirectorySiteContactsList Source #
Retrieves a list of directory site contacts, possibly filtered. This method supports paging.
See: directorySiteContactsList
smart constructor.
Request Lenses
dsclSearchString :: Lens' DirectorySiteContactsList (Maybe Text) Source #
Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
dsclIds :: Lens' DirectorySiteContactsList [Int64] Source #
Select only directory site contacts with these IDs.
dsclProFileId :: Lens' DirectorySiteContactsList Int64 Source #
User profile ID associated with this request.
dsclDirectorySiteIds :: Lens' DirectorySiteContactsList [Int64] Source #
Select only directory site contacts with these directory site IDs. This is a required field.
dsclSortOrder :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortOrder) Source #
Order of sorted results, default is ASCENDING.
dsclPageToken :: Lens' DirectorySiteContactsList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
dsclSortField :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortField) Source #
Field by which to sort the list.
dsclMaxResults :: Lens' DirectorySiteContactsList (Maybe Int32) Source #
Maximum number of results to return.