機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

電子メール検証にパッチを適用

patch

/crmRestApi/resources/11.13.18.05/emailVerification/{Id}

リクエスト

パス・パラメータ

• Id(required): integer
  検証済データの一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• Domain: string
  指定された電子メール・アドレスのドメイン部分。
• Duration: string
  電子メールの検証に要した時間(秒単位)。 最大タイムアウトは15秒で強制されます。 返されるタイムアウト・レスポンスの数を最小限に抑えるため、タイムアウト値を15秒以上に高めることをお薦めします。
• EmailAddress: string
  検証された電子メール・アドレス。
• EmailVerificationEnabled: string
  検証サービスが有効かどうかを示します。
• Id: integer
  検証済データの一意の識別子。
• IsComplainerOrFraudRisk: string
  Eメール・アドレスが、苦情の既知のリストに対して認識されるか、不正行為に使用されたかを示します。
• IsDisposableOrTemporary: string
  指定されたEメール・アドレスが一時メールボックスかどうかを示します。 組織によっては、マーケティング・コミュニケーションに使用しない一時的なメールボックスを作成する場合があります。
• ResponseCode: string
  有効、Valid_CatchAll、無効、タイムアウトなどのレスポンス・コード。
• ResponseMessage: string
  返されたレスポンス・コードのテキストによる説明。 たとえば、有効は、アカウント部分を含むEメール・アドレスが完全に検証されたことを意味します。Valid_CatchAllは、ドメインが検証されたが、アカウントを検証できなかったことを意味します。無効は、Eメール・アドレスが無効であり、受け入れられないことを意味し、タイムアウトは、指定したタイムアウト内に検証を完了できなかったことを意味します。 タイムアウトをレスポンス・コードとして受信した場合は、タイムアウト値を増やします。
• UserAccount: string
  指定されたEメール・アドレスのアカウント部分。
• VerificationCode: string
  提供された電子メール・アドレスの確認コード。
• VerificationHelpText: string
  返される検証ステータスのテキスト形式のヘルプの説明。
• VerificationStatus: string
  指定された電子メール・アドレスの検証ステータス。
• VerificationText: string
  返される検証コードのテキスト形式の説明。

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the email address provided.",
            "nullable":true
        },
        "ResponseCode":{
            "type":"string",
            "description":"The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.",
            "nullable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the email address provided.",
            "nullable":true
        },
        "Duration":{
            "type":"string",
            "description":"The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.",
            "nullable":true
        },
        "ResponseMessage":{
            "type":"string",
            "description":"A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.",
            "nullable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address that was verified.",
            "nullable":true
        },
        "IsComplainerOrFraudRisk":{
            "type":"string",
            "description":"Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.",
            "nullable":true
        },
        "IsDisposableOrTemporary":{
            "type":"string",
            "description":"Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the verified data.",
            "nullable":true
        },
        "EmailVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A textual description of the verification code returned.",
            "nullable":true
        },
        "Domain":{
            "type":"string",
            "description":"The domain portion of the email address provided.",
            "nullable":true
        },
        "UserAccount":{
            "type":"string",
            "description":"The account portion of the email address provided.",
            "nullable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : emailVerification-item-response

タイプ: object

ソースを表示

• Domain: string
  指定された電子メール・アドレスのドメイン部分。
• Duration: string
  電子メールの検証に要した時間(秒単位)。 最大タイムアウトは15秒で強制されます。 返されるタイムアウト・レスポンスの数を最小限に抑えるため、タイムアウト値を15秒以上に高めることをお薦めします。
• EmailAddress: string
  検証された電子メール・アドレス。
• EmailVerificationEnabled: string
  検証サービスが有効かどうかを示します。
• Id: integer
  検証済データの一意の識別子。
• IsComplainerOrFraudRisk: string
  Eメール・アドレスが、苦情の既知のリストに対して認識されるか、不正行為に使用されたかを示します。
• IsDisposableOrTemporary: string
  指定されたEメール・アドレスが一時メールボックスかどうかを示します。 組織によっては、マーケティング・コミュニケーションに使用しない一時的なメールボックスを作成する場合があります。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ResponseCode: string
  有効、Valid_CatchAll、無効、タイムアウトなどのレスポンス・コード。
• ResponseMessage: string
  返されたレスポンス・コードのテキストによる説明。 たとえば、有効は、アカウント部分を含むEメール・アドレスが完全に検証されたことを意味します。Valid_CatchAllは、ドメインが検証されたが、アカウントを検証できなかったことを意味します。無効は、Eメール・アドレスが無効であり、受け入れられないことを意味し、タイムアウトは、指定したタイムアウト内に検証を完了できなかったことを意味します。 タイムアウトをレスポンス・コードとして受信した場合は、タイムアウト値を増やします。
• UserAccount: string
  指定されたEメール・アドレスのアカウント部分。
• VerificationCode: string
  提供された電子メール・アドレスの確認コード。
• VerificationHelpText: string
  返される検証ステータスのテキスト形式のヘルプの説明。
• VerificationStatus: string
  指定された電子メール・アドレスの検証ステータス。
• VerificationText: string
  返される検証コードのテキスト形式の説明。

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseCode":{
            "type":"string",
            "description":"The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"string",
            "description":"The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseMessage":{
            "type":"string",
            "description":"A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address that was verified.",
            "nullable":true,
            "x-queryable":true
        },
        "IsComplainerOrFraudRisk":{
            "type":"string",
            "description":"Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.",
            "nullable":true,
            "x-queryable":true
        },
        "IsDisposableOrTemporary":{
            "type":"string",
            "description":"Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the verified data.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A textual description of the verification code returned.",
            "nullable":true,
            "x-queryable":true
        },
        "Domain":{
            "type":"string",
            "description":"The domain portion of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAccount":{
            "type":"string",
            "description":"The account portion of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」