<back to all web services
SmartsheetsTransferRequest
Requires Authentication
| Requires any of the roles: | Agent, Administrator |
The following routes are available for this service:| POST,OPTIONS | /v1/Smartsheets/TransferLines | | |
|---|
SmartsheetsTransferRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| agent | body | Agent | No | |
| lines | body | List<SmartsheetRecord> | No | |
Agent Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| AgentId | form | int | No | |
| Company | form | string | No | |
| AgentName | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| MiddleInitial | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Country | form | string | No | |
| Email | form | string | No | |
| EmailSignature | form | string | No | |
| HomePhone | form | string | No | |
| CellPhone | form | string | No | |
| WorkPhone | form | string | No | |
| InsLicensed | form | bool | No | |
| AgreeToDisclosures | form | bool | No | |
| AgreeToDate | form | DateTime? | No | |
| PaidDate | form | DateTime? | No | |
| AgentNumber | form | string | No | |
| ReferringAgent | form | string | No | |
| PlacementAgent | form | string | No | |
| CreatedDate | form | DateTime? | No | |
| UserId | form | Guid | No | |
| IsAgent | form | bool | No | |
| Package | form | string | No | |
| StoreName | form | string | No | |
| Notes | form | string | No | |
| Upline1 | form | int? | No | |
| Upline2 | form | int? | No | |
| Upline3 | form | int? | No | |
| Upline4 | form | int? | No | |
| MVPID | form | int? | No | |
| AVPID | form | int? | No | |
| RVPID | form | int? | No | |
| AgentLevel | form | decimal? | No | |
| IsMVP | form | bool | No | |
| IsRVP | form | bool | No | |
| IsAVP | form | bool | No | |
| IsAdmin | form | bool | No | |
| IsBusinessCardAdmin | form | bool | No | |
| TeamName | form | string | No | |
| LocationId | form | Guid | No | |
| CalendarId | form | Guid | No | |
| Rank | form | string | No | |
| NBC | form | bool | No | |
| Upline1Percent | form | decimal? | No | |
| Upline2Percent | form | decimal? | No | |
| Upline3Percent | form | decimal? | No | |
| Upline4Percent | form | decimal? | No | |
| AgentStatus | form | string | No | |
| Office | form | string | No | |
| DOB | form | DateTime? | No | |
| SSN | form | string | No | |
| Fax | form | string | No | |
| BusinessEmail | form | string | No | |
| ModifiedDate | form | DateTime? | No | |
| ModifiedBy | form | string | No | |
| TimeZone | form | string | No | |
| LeaderLocked | form | bool | No | |
| LastSubmittedBusinessDate | form | DateTime | No | |
| GracePeriodDate | form | DateTime | No | |
| Vested | form | bool | No | |
| DirectPay | form | DateTime | No | |
| DirectPayApprBy | form | string | No | |
| FactFinderBilling | form | decimal? | No | |
| FullName | form | string | No | |
| ByLastName | form | string | No | |
| IsSecurityLicensed | form | bool | No | |
| IsEncompassAdmin | form | bool | No | |
| ApiKey | form | Guid | No | |
| LastSessionId | form | string | No | |
| LastLogin | form | DateTime? | No | |
| MfaActive | form | bool | No | |
| RequireMFA | form | bool | No | |
| SMSPhoneNumber | form | string | No | |
| VerifiedEmailStatus | form | bool | No | |
| VerifiedCellPhoneStatus | form | bool | No | |
| SchedulerUrl | form | string | No | |
| QueueDefaults | form | QueueDefault | No | |
| Roles | form | List<string> | No | |
| PasswordUpdated | form | bool | No | |
| RestrictToSingleSession | form | bool | No | |
QueueDefault Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| LocationId | form | Guid | No | |
| Services | form | List<Guid> | No | |
SmartsheetRecord Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ID | form | int | No | |
| TableName | form | string | No | |
| PolicyAssociateId | form | Guid | No | |
| AgentName | form | string | No | |
| ClientName | form | string | No | |
| PolicyNumber | form | string | No | |
| TransactionId | form | string | No | |
| type | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /v1/Smartsheets/TransferLines HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SmartsheetsTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<agent>
<AVPID>0</AVPID>
<Address1>String</Address1>
<Address2>String</Address2>
<AgentId>0</AgentId>
<AgentLevel>0</AgentLevel>
<AgentName>String</AgentName>
<AgentNumber>String</AgentNumber>
<AgentStatus>String</AgentStatus>
<AgreeToDate>0001-01-01T00:00:00</AgreeToDate>
<AgreeToDisclosures>false</AgreeToDisclosures>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
<BusinessEmail>String</BusinessEmail>
<ByLastName>String</ByLastName>
<CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
<CellPhone>String</CellPhone>
<City>String</City>
<Company>String</Company>
<Country>String</Country>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DOB>0001-01-01T00:00:00</DOB>
<DirectPay>0001-01-01T00:00:00</DirectPay>
<DirectPayApprBy>String</DirectPayApprBy>
<Email>String</Email>
<EmailSignature>String</EmailSignature>
<FactFinderBilling>0</FactFinderBilling>
<Fax>String</Fax>
<FirstName>String</FirstName>
<FullName>String</FullName>
<GracePeriodDate>0001-01-01T00:00:00</GracePeriodDate>
<HomePhone>String</HomePhone>
<InsLicensed>false</InsLicensed>
<IsAVP>false</IsAVP>
<IsAdmin>false</IsAdmin>
<IsAgent>false</IsAgent>
<IsBusinessCardAdmin>false</IsBusinessCardAdmin>
<IsEncompassAdmin>false</IsEncompassAdmin>
<IsMVP>false</IsMVP>
<IsRVP>false</IsRVP>
<IsSecurityLicensed>false</IsSecurityLicensed>
<LastLogin>0001-01-01T00:00:00</LastLogin>
<LastName>String</LastName>
<LastSessionId>String</LastSessionId>
<LastSubmittedBusinessDate>0001-01-01T00:00:00</LastSubmittedBusinessDate>
<LeaderLocked>false</LeaderLocked>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<MVPID>0</MVPID>
<MfaActive>false</MfaActive>
<MiddleInitial>String</MiddleInitial>
<ModifiedBy>String</ModifiedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<NBC>false</NBC>
<Notes>String</Notes>
<Office>String</Office>
<Package>String</Package>
<PaidDate>0001-01-01T00:00:00</PaidDate>
<PasswordUpdated>false</PasswordUpdated>
<PlacementAgent>String</PlacementAgent>
<QueueDefaults>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<Services xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
</Services>
</QueueDefaults>
<RVPID>0</RVPID>
<Rank>String</Rank>
<ReferringAgent>String</ReferringAgent>
<RequireMFA>false</RequireMFA>
<RestrictToSingleSession>false</RestrictToSingleSession>
<Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Roles>
<SMSPhoneNumber>String</SMSPhoneNumber>
<SSN>String</SSN>
<SchedulerUrl>String</SchedulerUrl>
<State>String</State>
<StoreName>String</StoreName>
<TeamName>String</TeamName>
<TimeZone>String</TimeZone>
<Upline1>0</Upline1>
<Upline1Percent>0</Upline1Percent>
<Upline2>0</Upline2>
<Upline2Percent>0</Upline2Percent>
<Upline3>0</Upline3>
<Upline3Percent>0</Upline3Percent>
<Upline4>0</Upline4>
<Upline4Percent>0</Upline4Percent>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<VerifiedCellPhoneStatus>false</VerifiedCellPhoneStatus>
<VerifiedEmailStatus>false</VerifiedEmailStatus>
<Vested>false</Vested>
<WorkPhone>String</WorkPhone>
<Zip>String</Zip>
</agent>
<lines>
<SmartsheetRecord>
<AgentName>String</AgentName>
<ClientName>String</ClientName>
<ID>0</ID>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyNumber>String</PolicyNumber>
<TableName>String</TableName>
<TransactionId>String</TransactionId>
<type>String</type>
</SmartsheetRecord>
</lines>
</SmartsheetsTransferRequest>