BokaMera.API.Host

<back to all web services

MessageTypeQuery

// @DataContract
export class QueryBase
{
    /** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
    // @DataMember(Order=1)
    public Skip?: number;

    /** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
    // @DataMember(Order=2)
    public Take?: number;

    /** @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
    // @DataMember(Order=3)
    public OrderBy: string;

    /** @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
    // @DataMember(Order=4)
    public OrderByDesc: string;

    /** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
    // @DataMember(Order=5)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class MessageTypeQueryResponse
{
    /** @description The message type id */
    // @ApiMember(Description="The message type id")
    public Id: number;

    /** @description The message type name. */
    // @ApiMember(Description="The message type name.")
    public Name: string;

    /** @description The message type description. */
    // @ApiMember(Description="The message type description.")
    public Description: string;

    /** @description The maximum number of charachters that can be entered into message body using this type. */
    // @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
    public MaxCharacters: number;

    /** @description The default text that is always included when sending messages of this type. */
    // @ApiMember(Description="The default text that is always included when sending messages of this type.")
    public DefaultText: string;

    /** @description The send method for this type. 1 = Email, 2 = SMS. */
    // @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    public SendMethodId: number;

    public constructor(init?: Partial<MessageTypeQueryResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class MessageType extends BaseModel
{
    // @Required()
    public Name: string;

    // @Required()
    public Description: string;

    // @Required()
    public MaxCharacters: number;

    // @Required()
    public DefaultText: string;

    // @Required()
    public SendMethodId: number;

    public ModifiedDate?: string;
    public Id: number;

    public constructor(init?: Partial<MessageType>) { super(init); (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class MessageTypeQuery extends QueryDb<MessageType, MessageTypeQueryResponse>
{
    /** @description The message type id. */
    // @ApiMember(Description="The message type id.")
    public Id?: number;

    /** @description The message send method id. 1 = Email, 2 = SMS */
    // @ApiMember(Description="The message send method id. 1 = Email, 2 = SMS")
    public SendMethodId?: number;

    public constructor(init?: Partial<MessageTypeQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[];

    // @DataMember(Order=4)
    public Meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}

TypeScript MessageTypeQuery DTOs

GET /messages/templates/types HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			MaxCharacters: 0,
			DefaultText: String,
			SendMethodId: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}