Platform API

SavePermissionValue

Save change to a Permission value.

The following routes are available for this service:
All Verbs	/api/permissions/{PermissionId}/licensee/
All Verbs	/api/permissions/{PermissionId}/role/
All Verbs	/api/permissions/{PermissionId}/contact/


// @ApiResponse(Description="Returns a response status indicating success or not.")
export class SavePermissionValueResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SavePermissionValueResponse>) { (Object as any).assign(this, init); }
}

/** @description Save change to a Permission value. */
// @Api(Description="Save change to a Permission value.")
export class SavePermissionValue
{
    /** @description A permission Id that we're saving the permission for. */
    // @ApiMember(DataType="Guid", Description="A permission Id that we're saving the permission for.", IsRequired=true, Name="PermissionId")
    public PermissionId: string;

    /** @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. */
    // @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")
    public ObjectId: string;

    /** @description Value to set the permission to, may be true, false or null. */
    // @ApiMember(DataType="bool?", Description="Value to set the permission to, may be true, false or null.", Name="PermissionValue")
    public PermissionValue?: boolean;

    public constructor(init?: Partial<SavePermissionValue>) { (Object as any).assign(this, init); }
}

TypeScript SavePermissionValue 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 /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>