| Requires the role: | manager |
| POST | /users/invite |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class InviteGuestRequest extends PostOperationUnTenanted<InviteGuestResponse>
{
public String email = null;
public String getEmail() { return email; }
public InviteGuestRequest setEmail(String value) { this.email = value; return this; }
}
public static class PostOperationUnTenanted<TResponse> implements IPost
{
}
public static class InviteGuestResponse
{
public ResponseStatus responseStatus = null;
public Invitation invitation = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public InviteGuestResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Invitation getInvitation() { return invitation; }
public InviteGuestResponse setInvitation(Invitation value) { this.invitation = value; return this; }
}
public static class Invitation
{
public String firstName = null;
public String lastName = null;
public String email = null;
public String id = null;
public String getFirstName() { return firstName; }
public Invitation setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public Invitation setLastName(String value) { this.lastName = value; return this; }
public String getEmail() { return email; }
public Invitation setEmail(String value) { this.email = value; return this; }
public String getId() { return id; }
public Invitation setId(String value) { this.id = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/invite HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<InviteGuestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
<Email>String</Email>
</InviteGuestRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InviteGuestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
<Invitation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:Email>String</d2p1:Email>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:Id>String</d2p1:Id>
<d2p1:LastName>String</d2p1:LastName>
</Invitation>
<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>
</InviteGuestResponse>