Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Operation

Information of the operation

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


Request


PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
offsetIntegerfalse0Offset of the array of results.
limitIntegerfalse10Limit of results.
sortstringfalseidProperty of the entity to sort by.
sortModestringfalseAscMode of sorting.

Example request

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



FieldTypeRequiredDescription
idinttrue (only in UPDATE proccess)Id of the Company.
namestringtrueName of the Company.
codestringtrueGenerated code from the name of the company.
taxIdstringtrueTaxId of the Company.

companyEmailList

List of CompanyEmailfalse

companyAddressList

List of CompanyAddressfalse

companyPhoneList

List of CompanyPhonefalse

companyTaxAddress

CompanyTaxAddressfalse
remarkStringfalse
assignedUserUserfalseonly show: userName
profileTypeprofileTypefalse
companyCustomFieldValueListList of CompanyCustomFieldValuefalse
customerProfileListList of CustomerProfile

false


extendedNameStringfalse
paymentTypePaymentTypefalse
paymentPaymentfalse
paymentModePaymentModefalse
taxDocumentTypeTaxDocumentTypefalse
chainSourceChainSourcefalse
chainSegmentChainSegmentfalse
chainChannelChainSegmentfalse
languageLanguagefalse
chainProfileGroupChainProfileGroupfalse
reservationPriceModelTypeReservationPriceModelTypefalse

Example response

{
  "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"
    },
    {
      "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"
    }
  ]
}
  • No labels