Trendsic Platform Service

<back to all web services

DashboardLocationGrantRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboard/locationgrants/{UserId}
POST,DELETE,OPTIONS/v1/dashboard/locationgrants/{UserId}/{LocationId}
import Foundation
import ServiceStack

public class DashboardLocationGrantRequest : Codable
{
    public var userId:String
    public var locationId:String

    required public init(){}
}

public class DashboardLocationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var locations:[DashboardLocationOption] = []

    required public init(){}
}

public class DashboardLocationOption : Codable
{
    public var id:String
    public var name:String

    required public init(){}
}


Swift DashboardLocationGrantRequest 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/dashboard/locationgrants/{UserId}/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DashboardLocationGrantRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</DashboardLocationGrantRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardLocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Locations>
    <DashboardLocationOption>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Name>String</Name>
    </DashboardLocationOption>
  </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>
</DashboardLocationsResponse>