Get Partner Company

Method: GET

Objective: Provide the ability to get partner company information.

Usage:

  1. This will be the GET request.
  2. The service URL to be used will be http://<environment url>ws/rest/service/v1/admin/company?shortname=<urlencoded_shortname>.
  3. If the shortname parameter is not specified, then the URL will retrieve the entire list of partner companies.

Output:

If the service runs successfully, the output will be Status, Message, and Data.

Sample output JSON when shortname parameter is passed

{

"data":

[

{

"support_contactphone":null,

"elearn_url":null,

"addresses":

[

{

"zip":"94588",

"country":"US",

"city":"Pleasanton",

"phone":null,

"addressline3":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 Output for all partner companies

{

"data":

[

{

"companyname":"Partner Company - 01",

"shortname":"partner01",

"status":1

},

{

"companyname":"Partner Company - 02",

"shortname":"partner02",

"status":1

}

],

"message":

[

],

"status":200

}

Related Topics

Partner Company

Create Partner Company

Update Partner Company

Update Partner Company Shortname

Add (Update) Partner Company Shell Membership

Remove (Update) Partner Company Shell Membership



Last Published Friday, December 13, 2024