Versions Compared

Key

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

Operation

Information of the operation

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



Request


PropertyTypeRequiredType 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



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


Insert excerpt
Company
Company
nopaneltrue

Example response

Code Block
themeDJango
{
  "count": 1273,
  "offset": 0,
  "limit": 2,
  "list": [
    {
      "id": 11,
      "name": "Tesipro",
      "code": TES,
      "taxId": "1234",
      "iataId": null,
      "companyEmailList": [
        {
          "id": 11,
          "primary": true,
          "emailAddressType": {
            "id": 1,
            "code": "1",
            "name": "Personal"
          },
          "email": "ashawk5@cnet.com",
          "remark": null
        }
      ],
      "companyAddressList": [
        {
          "id": 11,
          "primary": true,
          "communicationLocationType": {
            "id": 1,
            "code": "1",
            "name": "Home"
          },
          "street": "80 Mallard Drive",
          "city": "Nashville",
          "stateProvName": "Tennessee",
          "stateProvCode": null,
          "postalCode": "37235",
          "countryCode": "NC",
          "remark": "Address Remark"
        }
      ],
      "companyPhoneList": [
        {
          "id": 11,
          "primary": true,
          "phoneLocationType": {
            "id": 6,
            "code": "6",
            "name": "Home"
          },
          "phoneTechType": {
            "id": 1,
            "code": "1",
            "name": "Voice"
          },
          "countryAccessCode": "+34",
          "areaCityCode": "B",
          "phoneNumber": "1-(615)108-5804",
          "extension": "1",
          "remark": "Phone Remark"
        }
      ],
      "companyTaxAddress": {
        "id": 1,
        "communicationLocationType": null,
        "street": "80 Mallard Drive",
        "city": "Nashville",
        "stateProvName": "Tennessee",
        "stateProvCode": null,
        "postalCode": "37235",
        "countryCode": "WS",
        "remark": "Address Remark"
      },
      "remark": "Company Remarks",
	  "assignedUser": {
         "userName": "Manager"
      }
    },
    {
      "id": 12,
      "name": "Wordify",
      "code": null,
      "taxId": "191361",
      "iataId": null,
      "companyEmailList": [
        {
          "id": 12,
          "primary": true,
          "emailAddressType": {
            "id": 1,
            "code": "1",
            "name": "Personal"
          },
          "email": "revans0@hatena.ne.jp",
          "remark": null
        }
      ],
      "companyAddressList": [
        {
          "id": 12,
          "primary": true,
          "communicationLocationType": {
            "id": 1,
            "code": "1",
            "name": "Home"
          },
          "street": "201 Utah Terrace",
          "city": "Philadelphia",
          "stateProvName": "Pennsylvania",
          "stateProvCode": null,
          "postalCode": "19136",
          "countryCode": "NU",
          "remark": "Address Remark"
        }
      ],
      "companyPhoneList": [
        {
          "id": 12,
          "primary": true,
          "phoneLocationType": {
            "id": 6,
            "code": "6",
            "name": "Home"
          },
          "phoneTechType": {
            "id": 1,
            "code": "1",
            "name": "Voice"
          },
          "countryAccessCode": "+34",
          "areaCityCode": "B",
          "phoneNumber": "1-(215)766-7602",
          "extension": "1",
          "remark": "Phone Remark"
        }
      ],
      "companyTaxAddress": {
        "id": 2,
        "communicationLocationType": null,
        "street": "201 Utah Terrace",
        "city": "Philadelphia",
        "stateProvName": "Pennsylvania",
        "stateProvCode": null,
        "postalCode": "19136",
        "countryCode": "PM",
        "remark": "Address Remark"
      },
      "remark": "Company Remarks",
	  "assignedUser": {
         "userName": "Administrator"
      },
  	  "profileType": {
	    "code": "12",
   		"name": "CustomerCompany",
        "nameI18n": "CustomerCompany",
        "colorCode": "#00ACC1"
      }
    }
  ]
}