regis

<back to all web services

OrganizationCreateRequest

Requires Authentication
Required permission:CreateOrganization
The following routes are available for this service:
POST/organization/create
"use strict";
export class OrganizationResponse {
    /** @param {{responseStatus?:ResponseStatus,organization_id?:number,organization_name?:string,email?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,phone_cell?:string,phone_bus?:string,phone_home?:string,is_institution?:boolean,is_vendor?:boolean,is_re?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    organization_id;
    /** @type {string} */
    organization_name;
    /** @type {string} */
    email;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_home;
    /** @type {boolean} */
    is_institution;
    /** @type {boolean} */
    is_vendor;
    /** @type {boolean} */
    is_re;
}
export class OrganizationCreateRequest {
    /** @param {{organization_name?:string,email?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,phone_home?:string,phone_cell?:string,phone_bus?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    organization_name;
    /** @type {string} */
    email;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript OrganizationCreateRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /organization/create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"organization_name":"String","email":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"organization_id":0,"organization_name":"String","email":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","phone_cell":"String","phone_bus":"String","phone_home":"String","is_institution":false,"is_vendor":false,"is_re":false}