Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : GetContactMetaData_response

Type: object

Show Source

• metadata: object metadata
  Meta data of attributes mapped to the customer master data

{
    "properties":{
        "metadata":{
            "description":"Meta data of attributes mapped to the customer master data",
            "type":"object",
            "properties":{
                "Attribute Name":{
                    "description":"Name of the contact attribute mapped",
                    "type":"object",
                    "properties":{
                        "editable":{
                            "description":"A boolean value which describes whether the attribute is editable or not",
                            "type":"boolean"
                        }
                    }
                }
            }
        }
    },
    "example":{
        "metadata":{
            "firstName":{
                "editable":true
            },
            "lastName":{
                "editable":true
            },
            "email":{
                "editable":false
            }
        },
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts/metadata"
            }
        ]
    }
}

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

{
    "description":"Meta data of attributes mapped to the customer master data",
    "type":"object",
    "properties":{
        "Attribute Name":{
            "description":"Name of the contact attribute mapped",
            "type":"object",
            "properties":{
                "editable":{
                    "description":"A boolean value which describes whether the attribute is editable or not",
                    "type":"boolean"
                }
            }
        }
    }
}

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

{
    "description":"Name of the contact attribute mapped",
    "type":"object",
    "properties":{
        "editable":{
            "description":"A boolean value which describes whether the attribute is editable or not",
            "type":"boolean"
        }
    }
}

400 Response

When request payload is not correct or properties are missing.

Body ()

Root Schema : errorModel400

Type: object

Show Source

• errorCode: string
  The CMS error code

  Example: 80205
• message: string
  The HTTP error message

  Example: Required properties are missing or invalid
• status: string
  The HTTP status code

  Example: 400

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The CMS error code",
            "type":"string",
            "example":80205
        },
        "message":{
            "description":"The HTTP error message",
            "type":"string",
            "example":"Required properties are missing or invalid"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string",
            "example":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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top