BokaMera.API.Host

<back to all web services

SendGetStartedMessage

The following routes are available for this service:
PUT/messages/getstartedWill send get started messages to all new customers that haven't get started yet

export class SendGetStartedMessageResponse
{
    public Companies: number;
    public SentCount: number;
    public ResponseStatus: ResponseStatus;

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

export class SendGetStartedMessage
{

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

TypeScript SendGetStartedMessage DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /messages/getstarted HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Companies: 0,
	SentCount: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}