API Documentation
\

\ET_CUDSupportRest

This class represents the create, update, delete operation for REST service.

Summary

Methods
Properties
Constants
get()
getMoreResults()
post()
patch()
delete()
$authStub
$props
$organizationId
$organizationKey
No constants found
No protected methods found
$lastPageNumber
$endpoint
$urlProps
$urlPropsRequired
$folderProperty
$folderMediaType
N/A
No private methods found
No private properties found
N/A

Properties

$authStub

$authStub : \ET_Client

Type

\ET_Client — The ET client object which performs the auth token, refresh token using clientID clientSecret

$props

$props : array

Type

array — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

$organizationId

$organizationId : string

Type

string — Organization Identifier.

$organizationKey

$organizationKey : string

Type

string — Organization Key.

$lastPageNumber

$lastPageNumber : integer

Type

integer — The last page number

$endpoint

$endpoint : string

Type

string — URL of the API endpoint

$urlProps

$urlProps : array<mixed,string>

Type

array<mixed,string> — array of string having properties or fields name found in the endpoint URL

$urlPropsRequired

$urlPropsRequired : array<mixed,string>

Type

array<mixed,string> — array of string having only required fields

$folderProperty

$folderProperty : string

Type

string — Folder property e.g. "Category", "CategoryID", etc.

$folderMediaType

$folderMediaType : string

Type

string — Folder Media Type e.g. "dataextension", "triggered_send", etc.

Methods

get()

get() : \ET_GetRest

Returns

\ET_GetRest —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

getMoreResults()

getMoreResults() : \ET_GetRest

Returns

\ET_GetRest —

returns more response from the GET REST service of type ET_GetRest Object

post()

post() : \ET_PostRest

Returns

\ET_PostRest —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

patch()

patch() : \ET_PatchRest

Returns

\ET_PatchRest —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

delete()

delete() : \ET_DeleteRest

Returns

\ET_DeleteRest —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service