| All Verbs | /api/permissions/{PermissionId}/licensee/ | ||
|---|---|---|---|
| All Verbs | /api/permissions/{PermissionId}/role/ | ||
| All Verbs | /api/permissions/{PermissionId}/contact/ |
import Foundation
import ServiceStack
/**
* Save change to a Permission value.
*/
// @Api(Description="Save change to a Permission value.")
public class SavePermissionValue : Codable
{
/**
* 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 var permissionId:String
/**
* 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 var objectId:String
/**
* 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 var permissionValue:Bool?
required public init(){}
}
// @ApiResponse(Description="Returns a response status indicating success or not.")
public class SavePermissionValueResponse : Codable
{
public var responseStatus:ResponseStatus
required public init(){}
}
Swift SavePermissionValue DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","PermissionValue":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}