GET api/Legend/{documentId}

Request Information

URI Parameters

Name	Description	Type	Additional information
documentId		string	Required

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfReferenceModel

Name	Description	Type	Additional information
success	Indica si la solicitud se procesó de manera satisfactoria	boolean	None.
message	Mensaje de la solicitud	string	None.
messageDetail	Lista de mensajes	Collection of string	None.
failureCode	Código de error en caso de existir	string	None.
data	Layout de respuesta de la solicitud	ReferenceModel	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "IssuerServiceId": 1,
    "Reference": "sample string 2",
    "Sequence": 3,
    "Statement": "sample string 4",
    "Title": true,
    "Source": "sample string 6",
    "ShowLegendIf": true,
    "InternalBankReferences": [
      {
        "BankId": 1,
        "BankCode": "sample string 2",
        "BankSortName": "sample string 3",
        "Reference": "sample string 4",
        "ReferenceSpei": "sample string 5",
        "CLABE": "sample string 6",
        "AccountNumber": "sample string 7",
        "Beneficiary": "sample string 8",
        "BankAccountId": "08de22c4-0fc8-5464-ba1f-9f7acc681ea8"
      },
      {
        "BankId": 1,
        "BankCode": "sample string 2",
        "BankSortName": "sample string 3",
        "Reference": "sample string 4",
        "ReferenceSpei": "sample string 5",
        "CLABE": "sample string 6",
        "AccountNumber": "sample string 7",
        "Beneficiary": "sample string 8",
        "BankAccountId": "08de22c4-0fc8-5464-ba1f-9f7acc681ea8"
      }
    ],
    "ExternalBankAccountReferences": [
      {
        "BankId": 1,
        "BankCode": "sample string 2",
        "BankSortName": "sample string 3",
        "Reference": "sample string 4",
        "ReferenceSpei": "sample string 5",
        "CLABE": "sample string 6",
        "AccountNumber": "sample string 7",
        "Beneficiary": "sample string 8",
        "BankAccountId": "08de22c4-0fc8-5464-ba1f-9f7acc681ea8"
      },
      {
        "BankId": 1,
        "BankCode": "sample string 2",
        "BankSortName": "sample string 3",
        "Reference": "sample string 4",
        "ReferenceSpei": "sample string 5",
        "CLABE": "sample string 6",
        "AccountNumber": "sample string 7",
        "Beneficiary": "sample string 8",
        "BankAccountId": "08de22c4-0fc8-5464-ba1f-9f7acc681ea8"
      }
    ],
    "ExternalBankReferences": [
      {
        "BankSortName": "sample string 1",
        "Agreement": "sample string 2",
        "Reference": "sample string 3",
        "IsBarCode": true,
        "BarCodeId": 5,
        "BarCode": "QEA=",
        "BankId": 6,
        "Amount": 7.0,
        "BusinessName": "sample string 8",
        "AccountNumber": "sample string 9"
      },
      {
        "BankSortName": "sample string 1",
        "Agreement": "sample string 2",
        "Reference": "sample string 3",
        "IsBarCode": true,
        "BarCodeId": 5,
        "BarCode": "QEA=",
        "BankId": 6,
        "Amount": 7.0,
        "BusinessName": "sample string 8",
        "AccountNumber": "sample string 9"
      }
    ],
    "ExternalPaymentMethodReferences": [
      {
        "Name": "sample string 1",
        "URL": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "URL": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseModelApiOfReferenceModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <IssuerServiceId>1</IssuerServiceId>
    <Reference>sample string 2</Reference>
    <Sequence>3</Sequence>
    <Statement>sample string 4</Statement>
    <Title>true</Title>
    <Source>sample string 6</Source>
    <ShowLegendIf>true</ShowLegendIf>
    <InternalBankReferences>
      <BankReferenceModel>
        <BankId>1</BankId>
        <BankCode>sample string 2</BankCode>
        <BankSortName>sample string 3</BankSortName>
        <Reference>sample string 4</Reference>
        <ReferenceSpei>sample string 5</ReferenceSpei>
        <CLABE>sample string 6</CLABE>
        <AccountNumber>sample string 7</AccountNumber>
        <Beneficiary>sample string 8</Beneficiary>
        <BankAccountId>08de22c4-0fc8-5464-ba1f-9f7acc681ea8</BankAccountId>
      </BankReferenceModel>
      <BankReferenceModel>
        <BankId>1</BankId>
        <BankCode>sample string 2</BankCode>
        <BankSortName>sample string 3</BankSortName>
        <Reference>sample string 4</Reference>
        <ReferenceSpei>sample string 5</ReferenceSpei>
        <CLABE>sample string 6</CLABE>
        <AccountNumber>sample string 7</AccountNumber>
        <Beneficiary>sample string 8</Beneficiary>
        <BankAccountId>08de22c4-0fc8-5464-ba1f-9f7acc681ea8</BankAccountId>
      </BankReferenceModel>
    </InternalBankReferences>
    <ExternalBankAccountReferences>
      <BankReferenceModel>
        <BankId>1</BankId>
        <BankCode>sample string 2</BankCode>
        <BankSortName>sample string 3</BankSortName>
        <Reference>sample string 4</Reference>
        <ReferenceSpei>sample string 5</ReferenceSpei>
        <CLABE>sample string 6</CLABE>
        <AccountNumber>sample string 7</AccountNumber>
        <Beneficiary>sample string 8</Beneficiary>
        <BankAccountId>08de22c4-0fc8-5464-ba1f-9f7acc681ea8</BankAccountId>
      </BankReferenceModel>
      <BankReferenceModel>
        <BankId>1</BankId>
        <BankCode>sample string 2</BankCode>
        <BankSortName>sample string 3</BankSortName>
        <Reference>sample string 4</Reference>
        <ReferenceSpei>sample string 5</ReferenceSpei>
        <CLABE>sample string 6</CLABE>
        <AccountNumber>sample string 7</AccountNumber>
        <Beneficiary>sample string 8</Beneficiary>
        <BankAccountId>08de22c4-0fc8-5464-ba1f-9f7acc681ea8</BankAccountId>
      </BankReferenceModel>
    </ExternalBankAccountReferences>
    <ExternalBankReferences>
      <BankReferenceExternalModel>
        <BankSortName>sample string 1</BankSortName>
        <Agreement>sample string 2</Agreement>
        <Reference>sample string 3</Reference>
        <IsBarCode>true</IsBarCode>
        <BarCodeId>5</BarCodeId>
        <BarCode>QEA=</BarCode>
        <BankId>6</BankId>
        <Amount>7</Amount>
        <BusinessName>sample string 8</BusinessName>
        <AccountNumber>sample string 9</AccountNumber>
      </BankReferenceExternalModel>
      <BankReferenceExternalModel>
        <BankSortName>sample string 1</BankSortName>
        <Agreement>sample string 2</Agreement>
        <Reference>sample string 3</Reference>
        <IsBarCode>true</IsBarCode>
        <BarCodeId>5</BarCodeId>
        <BarCode>QEA=</BarCode>
        <BankId>6</BankId>
        <Amount>7</Amount>
        <BusinessName>sample string 8</BusinessName>
        <AccountNumber>sample string 9</AccountNumber>
      </BankReferenceExternalModel>
    </ExternalBankReferences>
    <ExternalPaymentMethodReferences>
      <ExternalReferenceModel>
        <Name>sample string 1</Name>
        <URL>sample string 2</URL>
      </ExternalReferenceModel>
      <ExternalReferenceModel>
        <Name>sample string 1</Name>
        <URL>sample string 2</URL>
      </ExternalReferenceModel>
    </ExternalPaymentMethodReferences>
  </data>
</ResponseModelApiOfReferenceModel>