| All Verbs | /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Return true/false if a contact is connected to a licensee in a specific role.
*/
@Api(Description="Return true/false if a contact is connected to a licensee in a specific role.")
public static class IsConnectedInRole
{
/**
* Contact Id of the contact to determine if they have the role with the licensee.
*/
@ApiMember(DataType="Guid", Description="Contact Id of the contact to determine if they have the role with the licensee.", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* Role to check for.
*/
@ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")
public UUID RoleId = null;
/**
* Licensee Contact Id we are checking if we're connected to.
*/
@ApiMember(DataType="Guid", Description="Licensee Contact Id we are checking if we're connected to.", IsRequired=true, Name="LicenseeId")
public UUID LicenseeId = null;
public UUID getContactId() { return ContactId; }
public IsConnectedInRole setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getRoleId() { return RoleId; }
public IsConnectedInRole setRoleId(UUID value) { this.RoleId = value; return this; }
public UUID getLicenseeId() { return LicenseeId; }
public IsConnectedInRole setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
}
@ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")
public static class IsConnectedInRoleResponse
{
/**
* True or false depending on if the contact is connected to the licensee in the role.
*/
@ApiMember(DataType="bool", Description="True or false depending on if the contact is connected to the licensee in the role.", Name="IsConnected")
public Boolean IsConnected = null;
public ResponseStatus ResponseStatus = null;
public Boolean getIsConnected() { return IsConnected; }
public IsConnectedInRoleResponse setIsConnected(Boolean value) { this.IsConnected = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public IsConnectedInRoleResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"IsConnected":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}