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

/** @description Add a Users Profile information' */
// @Api(Description="Add a Users Profile information'")
export class AddUserProfile
{
    public UserIds: string[];
    public ContactIds: string[];
    public ProfileToShareId: string;

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

export class AddUserProfileResponse
{
    public Errors: ResponseError[];
    /** @description 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 ProfileToShareId: string;

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

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

TypeScript AddUserProfile 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

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}