Platform API

<back to all web services

SavePermissionValue

Save change to a Permission value.

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns a response status indicating success or not.")>]
    [<AllowNullLiteral>]
    type SavePermissionValueResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Save change to a Permission value.
    ///</summary>
    [<Api(Description="Save change to a Permission value.")>]
    [<AllowNullLiteral>]
    type SavePermissionValue() = 
        ///<summary>
        ///A permission Id that we're saving the permission for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="A permission Id that we're saving the permission for.", IsRequired=true, Name="PermissionId")>]
        member val PermissionId:Guid = new Guid() with get,set

        ///<summary>
        ///The object to save a permission for. This will either be a contact or role list item. Leave this blank if we're saving for the licensee.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The object to save a permission for. This will either be a contact or role list item. Leave this blank if we're saving for the licensee.", Name="ObjectId")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Value to set the permission to, may be true, false or null.
        ///</summary>
        [<ApiMember(DataType="bool?", Description="Value to set the permission to, may be true, false or null.", Name="PermissionValue")>]
        member val PermissionValue:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# SavePermissionValue DTOs

POST /api/permissions/{PermissionId}/licensee/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SavePermissionValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <PermissionId>00000000-0000-0000-0000-000000000000</PermissionId>
  <PermissionValue>false</PermissionValue>
</SavePermissionValue>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SavePermissionValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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>
</SavePermissionValueResponse>