NAV

RegionGetList

DomainAPI|Regions

The following routes are available for this service:
GET	/regions


export class RegionViewModel
{
    public regionId?: string;
    public regionDescription?: string;

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

export class RegionGetListResponse extends GetListResponse<RegionViewModel>
{

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

export class RegionGetList implements IGet
{

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

export class GetListResponse<TEntity>
{
    public items?: TEntity[];
    public responseStatus?: ResponseStatus;

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

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

GET /regions HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv

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

{
	items: 
	[
		{
			regionId: String,
			regionDescription: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}