View Source

Operation

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

Only accessible with permission of pms.integration.profile

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

GET

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

Request

Property	Type	Required	Path parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
offset	Integer	false	request parameter	0	Offset of the array of results.
limit	Integer	false	request parameter	10	Limit of results.
sort	String	false	request parameter	Id	Property of the entity to sort by.
sortMode	String	false	request parameter	Asc	Mode of sorting.

Example request

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

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Example response

{
	"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": "Tesipro"
			},
			"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
		}
	]
}