Get Partner Company

GET http://<environment url>ws/rest/service/v1/admin/company?shortname=<urlencoded_shortname>

Purpose

Gets partner company information.

If the shortname parameter is not specified in the URL, it will retrieve the entire list of partner companies.

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Success Response With Shortname Parameter

When the shortname is included in the request, the response is returned in the following format:

{

"data":

[

{

"support_contactphone":null,

"elearn_url":null,

"addresses":

[

{

"zip":"94588",

"country":"US",

"city":"Pleasanton",

"phone":null,

"addresstype": 1,

"addressline2":null,

"addressline1":"5815 Owens Drive",

"state":"CA",

"fax":null

}

],

"support_emailnotification":null,

"passwordpolicy":

{

"inform_exp":7,

"min_spechar":1,

"max_inactive":360,

"min_length":6,

"min_numericchar":1,

"max_attempts":5,

"min_alpchar":1,

"pwd_validfor":180,

"chk_uname":1,

"chk_prevpwd":0,

"max_length":0,

"chk_flname":1

},

"helpurl":null,

"description":null,

"support_contactemail":null,

"shortname":"partner01",

"url":null,

"companyname":"Partner Company - 01",

"elearn_instructions":null,

"elearn_contactemail":null,

"support_instructions":null,

"duns":null,

"elearn_label":null,

"status":1

}

],

"message": [ ],

"status":200

}

Sample Success Response For All Partner Companies

When the shortname is not included in the request, the response returns a list of all partner companies in the following format:

{

"data":[{

"companyname":"Partner Company - 01",

"shortname":"partner01",

"status":1

},

{

"companyname":"Partner Company - 02",

"shortname":"partner02",

"status":1

}

],

"message":["success"],

"status":200

}