Get company by Id

get

/PASService/rest/services/companies/{id}

Gets a company based on the specified company Id

Request

Path Parameters
  • Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?
    Company Id
Back to Top

Response

Supported Media Types

Default Response

successful operation
Back to Top

Examples

This example describes how to get a company based on the specified company Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/companies/05711222-7DB3-4EBD-A821-57A30A699B88"

Example Response Body

The following shows an example of the response body in JSON format:

"{
    "company": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/companies/05711222-7DB3-4EBD-A821-57A30A699B88",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/companies/05711222-7DB3-4EBD-A821-57A30A699B88/products",
                "rel": "products",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/companies/05711222-7DB3-4EBD-A821-57A30A699B88/plans",
                "rel": "plans",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=Calendar&codeValue=01",
                "rel": "codes/calendarCode",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "codes": [
            {
                "codeName": "AsCodeCalendar",
                "codeValue": "01",
                "longDescription": "New York Stock Exchange",
                "shortDescription": "NYSE"
            }
        ],
        "effectiveDate": "2000-01-01T00:00:00Z",
        "companyName": "Prototype Individual Child Company",
        "defaultCurrencyCode": "USD",
        "calendarCode": "01",
        "roleCode": "09",
        "products": [
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/companies/05711222-7DB3-4EBD-A821-57A30A699B88/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "productName": "Individual Prototype Product",
                "productDescription": "Individual Prototype Product",
                "effectiveFrom": "1980-01-01T00:00:00Z",
                "plans": [
                    {},
                    {},
                    {},
                    {},
                    {},
                    {}
                ],
                "productId": "3FE40262-1669-413E-ACBA-8615DD7DAA6F",
                "companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
            }
"
Back to Top