CCC API v8.4.0.0

<back to all web services

GetIdPx

The following routes are available for this service:
GET/api/idpx/{IdPxGuid}Retrieves specific id proxy configuration.
GetIdPx Parameters:
NameParameterData TypeRequiredDescription
IdPxGuidpathGuidYes
GetIdPxResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdPx Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
IdPxGuidbodyGuidNo
IdProviderGuidbodyGuidNo
PatternbodyStringNo
ParametersbodyStringNo
IdPxUrlbodyStringNo
NamebodyStringNo
DescriptionbodyStringNo
TypebodyIdPxTypeNo
IdPxType Parameters:
NameParameterData TypeRequiredDescription
IdPxTypeGuidbodyGuidNo
NamebodyStringNo
DescriptionbodyStringNo
WorkflowbodyStringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/idpx/{IdPxGuid} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "serviceGuid": "00000000000000000000000000000000",
  "idPxGuid": "00000000000000000000000000000000",
  "idProviderGuid": "00000000000000000000000000000000",
  "pattern": "String",
  "parameters": "String",
  "idPxUrl": "String",
  "name": "String",
  "description": "String",
  "type": {
    "idPxTypeGuid": "00000000000000000000000000000000",
    "name": "String",
    "description": "String",
    "workflow": "String"
  }
}