getMessageTypes — Retrieving message metadata
The getMessageTypes
method retrieves message metadata that can be linked back via getPendingEmailsSimple.
The API endpoint is:
https://api.sitelock.com/v1/partner
Request format
-
SiteLockOnlineRequest: This element is used to delineate the full API request.
-
authentication: The partner’s username, password, and branding
-
username: The partner’s API username
-
password: The partner’s API password
-
partner: (Optional) The brand name to use in messaging
-
-
getMessageTypes: The method name
-
Response format
-
SiteLockOnlineResponse: This element is used to delineate the full API response.
-
getMessageTypes: The method name
-
messages: A list of messages
-
message: (Repeatable) A message
-
name: The name of the message
-
code: The code for this message
-
id: The ID of the message
-
The
message_id
fromgetPendingEmailsSimple
references this ID.
-
-
defaultCopy: The copy used by SiteLock
-
scan_code: When applicable, this references a scan (for example,
xss_scan
). -
severity: The severity of the condition that this message applies to.
-
type: The general category of the message
-
-
-
-
Example response
<SiteLockOnlineResponse>
<getMessageTypes>
<messages>
<message>
<name>Postal verification no response</name>
<code>address_verification_reminder_1</code>
<id>5</id>
<defaultCopy> --snipped--</defaultCopy>
<scan_code></scan_code>
<severity>notice</severity>
<type>security</type>
</message>
</messages>
</getMessageTypes>
</SiteLockOnlineResponse>