sfgboxapi

<back to all web services

UsersIntendedAdd

The following routes are available for this service:
POST/users_intended

export class UsersIntendedAddResponse
{
    // @DataMember(Order=2)
    public firstName: string;

    // @DataMember(Order=3)
    public lastName: string;

    // @DataMember(Order=4)
    public identificationNumber: string;

    // @DataMember(Order=5)
    public phoneNumber: string;

    // @DataMember(Order=6)
    public latitude: number;

    // @DataMember(Order=7)
    public longitude: number;

    // @DataMember(Order=8)
    public usersDetailsId?: number;

    // @DataMember(Order=9)
    public responseStatus: ResponseStatus;

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

// @DataContract
export class UsersIntendedAdd
{
    // @DataMember(Order=2)
    public firstName: string;

    // @DataMember(Order=3)
    public lastName: string;

    // @DataMember(Order=4)
    public identificationNumber: string;

    // @DataMember(Order=5)
    public phoneNumber: string;

    // @DataMember(Order=6)
    public latitude: number;

    // @DataMember(Order=7)
    public longitude: number;

    // @DataMember(Order=8)
    public usersDetailsId?: number;

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

TypeScript UsersIntendedAdd 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.

POST /users_intended HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	firstName: String,
	lastName: String,
	identificationNumber: String,
	phoneNumber: String,
	latitude: 0,
	longitude: 0,
	usersDetailsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	firstName: String,
	lastName: String,
	identificationNumber: String,
	phoneNumber: String,
	latitude: 0,
	longitude: 0,
	usersDetailsId: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}