Platform API

<back to all web services

InviteContact

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class InviteContact
    {
        /**
        * Contact Id inviting the contact
        */
        @ApiMember(DataType="Guid", Description="Contact Id inviting the contact", IsRequired=true, Name="ContactId")
        public UUID ContactId = null;

        /**
        * Contact Id of the virtual contact invited to be real.
        */
        @ApiMember(DataType="Guid", Description="Contact Id of the virtual contact invited to be real.", Name="ToContactId")
        public UUID ToContactId = null;

        /**
        * Email Address of the real/ virtual contact to be invited.
        */
        @ApiMember(DataType="string", Description="Email Address of the real/ virtual contact to be invited.", IsRequired=true, Name="EmailAddress")
        public String EmailAddress = null;

        /**
        * List of roles to invite the contact
        */
        @ApiMember(DataType="List<Guid>", Description="List of roles to invite the contact", IsRequired=true, Name="Roles")
        public ArrayList<UUID> Roles = new ArrayList<UUID>();
        
        public UUID getContactId() { return ContactId; }
        public InviteContact setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getToContactId() { return ToContactId; }
        public InviteContact setToContactId(UUID value) { this.ToContactId = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public InviteContact setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public ArrayList<UUID> getRoles() { return Roles; }
        public InviteContact setRoles(ArrayList<UUID> value) { this.Roles = value; return this; }
    }

    @ApiResponse(Description="Contact Id of the newly invited/ created contact")
    public static class AddContactResponse
    {
        public UUID ContactId = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getContactId() { return ContactId; }
        public AddContactResponse setContactId(UUID value) { this.ContactId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AddContactResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java InviteContact DTOs

POST /api/contacts/{ContactId}/invite/contact HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InviteContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <EmailAddress>String</EmailAddress>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Roles>
  <ToContactId>00000000-0000-0000-0000-000000000000</ToContactId>
</InviteContact>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AddContactResponse>