Jump to

• Request
• Response

Get a PayerDirectoryEntry

get

/20180828/payerDirectoryEntries/{payerDirectoryEntryId}

This path retrieves information about a PayerDirectoryEntry.

Request

Path Parameters

• payerDirectoryEntryId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the PayerDirectoryEntry.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The PayerDirectoryEntry was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : PayerDirectoryEntry

Type: object

A PayerDirectoryEntry represents contact information and other identifying information about a payer.

Show Source

• compartmentId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
• directoryEntry(required): object DirectoryEntry
  Contact information and other identifying information for a Payer or Provider.
• displayName: string
  A user-friendly name. This name does not have to be unique, and it can be changed.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
• id(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the PayerDirectoryEntry.
• lifecycleDetails: string
  A message that describes the current state of the PayerDirectoryEntry in more detail. For example, this message can be used to provide actionable information for a resource in a Failed state.
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "DELETED", "FAILED" ]

  The current state of the PayerDirectoryEntry.
• payerId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the payer that the entry is for.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
• timeCreated(required): string(date-time)
  The date and time that the PayerDirectoryEntry was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time that the PayerDirectoryEntry was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`

{
    "description":"A PayerDirectoryEntry represents contact information and other identifying information about a payer.\n",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"payerDirectoryEntry",
        "ocidEntityType":"cdexhubpayerdirectoryentry",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetPayerDirectoryEntry",
        "listResourcesOperationId":"ListPayerDirectoryEntries",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"PayerDirectoryEntry",
            "scope":"internal"
        },
        "workRequestDetails":{
            "workRequestEntityType":"cdexhubworkrequest",
            "workRequestGetOperationId":"GetWorkRequest",
            "successfulLifecycleStates":[
                "SUCCEEDED"
            ],
            "failedLifecycleStates":[
                "FAILED",
                "CANCELED"
            ]
        }
    },
    "required":[
        "id",
        "payerId",
        "directoryEntry",
        "compartmentId",
        "lifecycleState",
        "timeCreated"
    ],
    "properties":{
        "id":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the PayerDirectoryEntry.",
            "type":"string"
        },
        "payerId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the payer that the entry is for.",
            "type":"string"
        },
        "directoryEntry":{
            "$ref":"#/definitions/DirectoryEntry"
        },
        "displayName":{
            "description":"A user-friendly name. This name does not have to be unique, and it can be changed.",
            "type":"string"
        },
        "compartmentId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time that the PayerDirectoryEntry was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time that the PayerDirectoryEntry was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the PayerDirectoryEntry.",
            "type":"string",
            "enum":[
                "ACTIVE",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the PayerDirectoryEntry in more detail. For example, this message\ncan be used to provide actionable information for a resource in a Failed state.\n",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`

Nested Schema : DirectoryEntry

Type: object

Contact information and other identifying information for a Payer or Provider.

Show Source

• alternateContactMethods: array alternateContactMethods
  Maximum Number of Items: 32

  Ways to contact the entity through a non-standard channel.
• city: string
  Name of a city, town, village, or unincorporated area in which the address is located. Examples: Seattle (a city in Washington State) Beaver Dam (a town in Wisconsin) Hambledon (a village in the UK) Belkofksi (an unincorporated area in Alaska)
• country: string
  A country or nation, using ISO-3166-1 alpha-3 format. Examples: USA CAN
• district: string
  A county or district within a state. Examples: King County (a county in Washington State) Caribou (a district in British Columbia)
• email: string
  Email addresses for the entity.
• fax: string
  A telephone number suitable for receiving faxes, in E.164 format.
• phone: string
  A telephone number suitable for voice communication, in E.164 format.
• postalCode: string
  A ZIP code in the United States, or the equivalent in another country. Examples: 55414 (A ZIP code in Minneapolis, MN) NW1 (A postal code in London, UK)
• secondaryAddressLine: string
  A portion of the address that does not properly fit into the other fields. Examples: PO Box #6789 Suite 12345
• sms: string
  Telephone numbers suitable for sending SMS messages to, in E.164 format.
• state: string
  A state or province within a country. Examples: California British Columbia
• streetAddress: string
  A physical address suited for the receipt of physical packages or documents, and/or for visiting in person.

  Example: 12345 Foo Street

{
    "description":"Contact information and other identifying information for a Payer or Provider.",
    "properties":{
        "streetAddress":{
            "description":"A physical address suited for the receipt of physical packages or documents, and/or for visiting in person.\n",
            "example":"12345 Foo Street\n",
            "type":"string"
        },
        "secondaryAddressLine":{
            "description":"A portion of the address that does not properly fit into the other fields.\n\nExamples:\n  PO Box #6789\n  Suite 12345\n",
            "type":"string"
        },
        "city":{
            "description":"Name of a city, town, village, or unincorporated area in which the address is located.\n\nExamples:\n  Seattle (a city in Washington State)\n  Beaver Dam (a town in Wisconsin)\n  Hambledon (a village in the UK)\n  Belkofksi (an unincorporated area in Alaska)\n",
            "type":"string"
        },
        "district":{
            "description":"A county or district within a state.\n\nExamples:\n  King County (a county in Washington State)\n  Caribou (a district in British Columbia)\n",
            "type":"string"
        },
        "state":{
            "description":"A state or province within a country.\n\nExamples:\n  California\n  British Columbia\n",
            "type":"string"
        },
        "postalCode":{
            "description":"A ZIP code in the United States, or the equivalent in another country.\n\nExamples:\n  55414 (A ZIP code in Minneapolis, MN) \n  NW1 (A postal code in London, UK)\n",
            "type":"string"
        },
        "country":{
            "description":"A country or nation, using ISO-3166-1 alpha-3 format.\n\nExamples:\n  USA\n  CAN\n",
            "type":"string"
        },
        "phone":{
            "description":"A telephone number suitable for voice communication, in E.164 format.",
            "type":"string"
        },
        "fax":{
            "description":"A telephone number suitable for receiving faxes, in E.164 format.",
            "type":"string"
        },
        "sms":{
            "description":"Telephone numbers suitable for sending SMS messages to, in E.164 format.",
            "type":"string"
        },
        "email":{
            "description":"Email addresses for the entity.",
            "type":"string"
        },
        "alternateContactMethods":{
            "description":"Ways to contact the entity through a non-standard channel.",
            "type":"array",
            "maxItems":"32",
            "items":{
                "$ref":"#/definitions/AlternateContactMethod"
            }
        }
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : alternateContactMethods

Type: array

Maximum Number of Items: 32

Ways to contact the entity through a non-standard channel.

Show Source

• Array of: object AlternateContactMethod
  A non-standard communications channel for a payer or provider, e.g. WhatsApp, Discord.

{
    "description":"Ways to contact the entity through a non-standard channel.",
    "type":"array",
    "maxItems":"32",
    "items":{
        "$ref":"#/definitions/AlternateContactMethod"
    }
}

Nested Schema : AlternateContactMethod

Type: object

A non-standard communications channel for a payer or provider, e.g. WhatsApp, Discord.

Show Source

• address: string
  Where to find the entity when using the method.
• method: string
  Name of the contact method, e.g. WhatsApp, Discord.

{
    "description":"A non-standard communications channel for a payer or provider, e.g. WhatsApp, Discord.\n",
    "properties":{
        "method":{
            "description":"Name of the contact method, e.g. WhatsApp, Discord.",
            "type":"string"
        },
        "address":{
            "description":"Where to find the entity when using the method.",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top