Trendsic Platform Service

<back to all web services

LocationsRequest

Requires Authentication
Required roles:Administrator, Administrator, AdministratorRequires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Locations/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Locations
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Location
            Public Overridable Property Id As Guid
            Public Overridable Property ClientId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property City As String
            Public Overridable Property State As String
            Public Overridable Property Zip As String
            Public Overridable Property Phone As String
            Public Overridable Property Fax As String
            Public Overridable Property TimeZone As String
            Public Overridable Property Active As Boolean
            Public Overridable Property EntDate As Date
            Public Overridable Property ModDate As Date
        End Class

        Public Partial Class LocationsRequest
            Public Overridable Property Id As Guid
            Public Overridable Property Locations As List(Of Location) = New List(Of Location)
        End Class

        Public Partial Class LocationsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Locations As List(Of Location) = New List(Of Location)
        End Class
    End Namespace
End Namespace

VB.NET LocationsRequest DTOs

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/Locations/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LocationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Locations>
    <Location>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Fax>String</Fax>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <Phone>String</Phone>
      <State>String</State>
      <TimeZone>String</TimeZone>
      <Zip>String</Zip>
    </Location>
  </Locations>
</LocationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Locations>
    <Location>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Fax>String</Fax>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <Phone>String</Phone>
      <State>String</State>
      <TimeZone>String</TimeZone>
      <Zip>String</Zip>
    </Location>
  </Locations>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</LocationsResponse>