getContactMetadata
get
/ccadmin/v1/selfservice/contacts/metadata
Get contact meta data which represents the attributes which are mapped to customer data master contact attributes . Note : This endpoint is operational only when customer data sync is enabled.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : GetContactMetaData_response
Type:
Show Source
object
-
metadata:
object metadata
Meta data of attributes mapped to the customer master data
Example:
{
"metadata":{
"firstName":{
"editable":true
},
"lastName":{
"editable":true
},
"email":{
"editable":false
}
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/selfservice/contacts/metadata"
}
]
}
Nested Schema : metadata
Type:
object
Meta data of attributes mapped to the customer master data
Show Source
-
Attribute Name:
object Attribute Name
Name of the contact attribute mapped
Nested Schema : Attribute Name
Type:
object
Name of the contact attribute mapped
Show Source
-
editable:
boolean
A boolean value which describes whether the attribute is editable or not
400 Response
When request payload is not correct or properties are missing.
Root Schema : errorModel400
Type:
Show Source
object
-
errorCode:
string
The CMS error codeExample:
80205
-
message:
string
The HTTP error messageExample:
Required properties are missing or invalid
-
status:
string
The HTTP status codeExample:
400
Default Response
The default error response.
The following are the internal error codes thrown by this API:
|Error Code|Description|
|------------------|------------------|
|58001|Internal server error.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code