| GET | /api/idpx/{IdPxGuid} | Retrieves specific id proxy configuration. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdPxGuid | path | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | body | Guid | No | |
| IdPxGuid | body | Guid | No | |
| IdProviderGuid | body | Guid | No | |
| Pattern | body | String | No | |
| Parameters | body | String | No | |
| IdPxUrl | body | String | No | |
| Name | body | String | No | |
| Description | body | String | No | |
| Type | body | IdPxType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdPxTypeGuid | body | Guid | No | |
| Name | body | String | No | |
| Description | body | String | No | |
| Workflow | body | String | No |
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
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"
}
}