Versions Compared

Old Version 5

changes.mady.by.user David Garcerán

Saved on

compared with

New Version Current

changes.mady.by.user David Garcerán

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

This endpoint returns all the companies in a chain with only the most basic data of them

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.profile


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/company/summary



Request


PropertyTypeRequiredPath parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortStringfalserequest parameterIdProperty of the entity to sort by.
sortModeStringfalserequest parameterAscMode of sorting.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/company/summary



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


Insert excerpt
CompanySummary
CompanySummary
nopaneltrue

Example response

Code Block
themeDJango
{
	"count": 1275,
	"offset": 0,
	"limit": 2,
	"list": [{
			"id": 20,
			"chainId": 1,
			"profileType": {
				"id": 2,
				"code": null,
				"name": "Company",
				"nameI18n": null,
				"nameI18nId": null,
				"colorCode": null
			},
			"chainProfileGroupId": null,
			"chainProfileTypeId": 1,
			"code": "TESIP",
			"name": "Tesipro",
			"extendedName": null,
			"iata": null,
			"taxId": "1234",
			"languageId": null,
			"remark": "Company Remarks",
			"primaryAddressStreet": "85 Caliangt Road",
			"primaryAddressCity": "Metairie",
			"primaryAddressStateProvName": "Louisiana",
			"primaryAddressStateProvId": null,
			"primaryAddressPostalCode": "70033",
			"primaryAddressCountryId": 76,
			"primaryPhoneNumber": "1-(504)229-6280",
			"primaryEmail": "dnicholsox@posterous.com",
			"assignedUser": {
				"id": 14,
				"userName": "DgarceranTesipro"
			},
			"active": true,
			"inactiveReason": null,
			"entityProtected": null
		},
		{
			"id": 21,
			"chainId": 1,
			"profileType": {
				"id": 2,
				"code": null,
				"name": "Company",
				"nameI18n": null,
				"nameI18nId": null,
				"colorCode": null
			},
			"chainProfileGroupId": null,
			"chainProfileTypeId": 1,
			"code": "TESBC",
			"name": "Tesipro BCN",
			"extendedName": null,
			"iata": null,
			"taxId": "QWERTY",
			"languageId": null,
			"remark": "Company Remarks",
			"primaryAddressStreet": "28870 Barnett Hill",
			"primaryAddressCity": "Bradenton",
			"primaryAddressStateProvName": "Florida",
			"primaryAddressStateProvId": null,
			"primaryAddressPostalCode": "34210",
			"primaryAddressCountryId": 51,
			"primaryPhoneNumber": "1-(727)578-5381",
			"primaryEmail": "tdavis69@archive.org",
			"assignedUser": null,
			"active": true,
			"inactiveReason": null,
			"entityProtected": null
		}
	]
}