Platform API

<back to all web services

AddUserProfile

Add a Users Profile information'

Requires Authentication
The following routes are available for this service:
POST/api/profiles
import Foundation
import ServiceStack

/**
* Add a Users Profile information'
*/
// @Api(Description="Add a Users Profile information'")
public class AddUserProfile : Codable
{
    public var userIds:[String]
    public var contactIds:[String]
    public var profileToShareId:String

    required public init(){}
}

public class AddUserProfileResponse : Codable
{
    public var errors:[ResponseError]
    /**
    * Guid representing the object that is the User Profile Id in Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the object that is the User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
    public var profileToShareId:String

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift AddUserProfile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/profiles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"UserIds":["00000000-0000-0000-0000-000000000000"],"ContactIds":["00000000-0000-0000-0000-000000000000"],"ProfileToShareId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"ProfileToShareId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}