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
"use strict";
export class AddUserProfile {
    /** @param {{UserIds?:string[],ContactIds?:string[],ProfileToShareId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    UserIds;
    /** @type {string[]} */
    ContactIds;
    /** @type {string} */
    ProfileToShareId;
}
export class AddUserProfileResponse {
    /** @param {{Errors?:ResponseError[],ProfileToShareId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseError[]} */
    Errors;
    /**
     * @type {string}
     * @description Guid representing the object that is the User Profile Id in Eros. */
    ProfileToShareId;
    /**
     * @type {ResponseStatus}
     * @description Service Stack Response Status. */
    ResponseStatus;
}

JavaScript AddUserProfile DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}