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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Add a Users Profile information'
*/
@Api(Description="Add a Users Profile information'")
open class AddUserProfile
{
    open var UserIds:ArrayList<UUID>? = null
    open var ContactIds:ArrayList<UUID>? = null
    open var ProfileToShareId:UUID? = null
}

open class AddUserProfileResponse
{
    open var Errors:ArrayList<ResponseError>? = null
    /**
    * 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")
    open var ProfileToShareId:UUID? = null

    /**
    * Service Stack Response Status.
    */
    @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}