PUT v1/Location/GetAgentToDetails

Returns details for a given agent

Request Information

Parameters (ParameterName * = required)

Name

Description

Sample Value

AgentToId *

ID of a payout agent (ex. BANCOMER

489712

AgentToLocId

Get logo at location level

12563211

UseMobileImage

Flag to return mobile generic Agent logo

Not available

DeliveryMethod

Delivery method to determine which generic logo should be shown

Not available

Response Information

Response body formats

application/json, text/json

Sample:

{
  "id": 1,
  "locationId": 2,
  "name": "sample string 3",
  "openPayment": true,
  "payoutType": "NotOpen",
  "digitalAlias": "sample string 5",
  "isPremiumRate": true,
  "selectedAgentToInfoList": [
    {
      "agentToId": 1,
      "selectedAgentId": 2,
      "selectedAgentName": "sample string 3",
      "selectedAgentNo": "sample string 4"
    },
    {
      "agentToId": 1,
      "selectedAgentId": 2,
      "selectedAgentName": "sample string 3",
      "selectedAgentNo": "sample string 4"
    },
    {
      "agentToId": 1,
      "selectedAgentId": 2,
      "selectedAgentName": "sample string 3",
      "selectedAgentNo": "sample string 4"
    }
  ],
  "correspondentPayoutBrand": "sample string 7",
  "digitalCorrespondentGroups": true
}

application/xml, text/xml

Sample:

<AgentToResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>sample string 7</_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>
  <_x003C_DigitalAlias_x003E_k__BackingField>sample string 5</_x003C_DigitalAlias_x003E_k__BackingField>
  <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>true</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
  <_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
  <_x003C_IsPremiumRate_x003E_k__BackingField>true</_x003C_IsPremiumRate_x003E_k__BackingField>
  <_x003C_LocationId_x003E_k__BackingField>2</_x003C_LocationId_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>sample string 3</_x003C_Name_x003E_k__BackingField>
  <_x003C_OpenPayment_x003E_k__BackingField>true</_x003C_OpenPayment_x003E_k__BackingField>
  <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
  <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo">
    <d2p1:SelectedAgentToInfo>
      <d2p1:AgentToId>1</d2p1:AgentToId>
      <d2p1:SelectedAgentId>2</d2p1:SelectedAgentId>
      <d2p1:SelectedAgentName>sample string 3</d2p1:SelectedAgentName>
      <d2p1:SelectedAgentNo>sample string 4</d2p1:SelectedAgentNo>
    </d2p1:SelectedAgentToInfo>
    <d2p1:SelectedAgentToInfo>
      <d2p1:AgentToId>1</d2p1:AgentToId>
      <d2p1:SelectedAgentId>2</d2p1:SelectedAgentId>
      <d2p1:SelectedAgentName>sample string 3</d2p1:SelectedAgentName>
      <d2p1:SelectedAgentNo>sample string 4</d2p1:SelectedAgentNo>
    </d2p1:SelectedAgentToInfo>
    <d2p1:SelectedAgentToInfo>
      <d2p1:AgentToId>1</d2p1:AgentToId>
      <d2p1:SelectedAgentId>2</d2p1:SelectedAgentId>
      <d2p1:SelectedAgentName>sample string 3</d2p1:SelectedAgentName>
      <d2p1:SelectedAgentNo>sample string 4</d2p1:SelectedAgentNo>
    </d2p1:SelectedAgentToInfo>
  </_x003C_SelectedAgentToInfoList_x003E_k__BackingField>
</AgentToResponse>