Resource:A log of errors for customer useC# Rel Const:Rels.CustomerSvc.ErrorLogsURI template:{id}/errorlogs{?pgsiz,pgnum,rql,sort}Obtain URI from:
Get error log records for a given customer
Success status: 200
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | customer id |
pgsiz | int | max records to return per response; use "next" or "prev" link to paginate |
pgnum | int | considering pgsiz, returns the pgnum-th page, 1-indexed |
rql | string | see RQL documentation |
sort | string | see RQL documentation |
Type | Description | |
---|---|---|
TotalResults | int | |
ResourceList | IList<Customer.Models.CustomerErrorLog> | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime? ... | |
ErrorDescription | string | |
Task | string | |
Subtask | string | |
Links | IList<WebApi.Hal.Link> | |
- next | ||
- prev |
{ "totalResults": 1, "_embedded": { "item": [ { "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00", "errorDescription": "str", "task": "str", "subtask": "str" } ] } }
Create a new customer error log record
Success status: 200
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | customer id |
Type | Description | |
---|---|---|
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime? ... | |
ErrorDescription | string | |
Task | string | |
Subtask | string |
Sample content-type: application/hal+json |
{ "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00", "errorDescription": "str", "task": "str", "subtask": "str" }
Type | Description | |
---|---|---|
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime? ... | |
ErrorDescription | string | |
Task | string | |
Subtask | string |
{ "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00", "errorDescription": "str", "task": "str", "subtask": "str" }
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.