Platform API

AddUserProfile

Add a Users Profile information'

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.*;

public class dtos
{

    /**
    * Add a Users Profile information'
    */
    @Api(Description="Add a Users Profile information'")
    public static class AddUserProfile
    {
        public ArrayList<UUID> UserIds = null;
        public ArrayList<UUID> ContactIds = null;
        public UUID ProfileToShareId = null;
        
        public ArrayList<UUID> getUserIds() { return UserIds; }
        public AddUserProfile setUserIds(ArrayList<UUID> value) { this.UserIds = value; return this; }
        public ArrayList<UUID> getContactIds() { return ContactIds; }
        public AddUserProfile setContactIds(ArrayList<UUID> value) { this.ContactIds = value; return this; }
        public UUID getProfileToShareId() { return ProfileToShareId; }
        public AddUserProfile setProfileToShareId(UUID value) { this.ProfileToShareId = value; return this; }
    }

    public static class AddUserProfileResponse
    {
        public ArrayList<ResponseError> Errors = 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")
        public UUID ProfileToShareId = null;

        /**
        * Service Stack Response Status.
        */
        @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ResponseError> getErrors() { return Errors; }
        public AddUserProfileResponse setErrors(ArrayList<ResponseError> value) { this.Errors = value; return this; }
        public UUID getProfileToShareId() { return ProfileToShareId; }
        public AddUserProfileResponse setProfileToShareId(UUID value) { this.ProfileToShareId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AddUserProfileResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java AddUserProfile DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}}}