Trendsic Platform Service

<back to all web services

BranchGrantRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/branch/grants/{UserId}
POST,DELETE,OPTIONS/v1/branch/grants/{UserId}/{BranchId}
"use strict";
export class Branch {
    /** @param {{BranchId?:string,TenantId?:string,Name?:string,Code?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Phone?:string,Latitude?:number,Longitude?:number,TimeZoneId?:string,IsDefault?:boolean,IsActive?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchId;
    /** @type {string} */
    TenantId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Code;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Phone;
    /** @type {?number} */
    Latitude;
    /** @type {?number} */
    Longitude;
    /** @type {string} */
    TimeZoneId;
    /** @type {boolean} */
    IsDefault;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class BranchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Branches?:Branch[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Branch[]} */
    Branches = [];
}
export class BranchGrantRequest {
    /** @param {{UserId?:string,BranchId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    BranchId;
}

JavaScript BranchGrantRequest DTOs

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

HTTP + CSV

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

POST /v1/branch/grants/{UserId}/{BranchId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Branches":[{"BranchId":"00000000000000000000000000000000","TenantId":"00000000000000000000000000000000","Name":"String","Code":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Latitude":0,"Longitude":0,"TimeZoneId":"String","IsDefault":false,"IsActive":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}]}