eQuipAPI

<back to all web services

FindInvalidBadges

Gets the errors for an invalid user badge barcode.

The following routes are available for this service:
GET/invalidbadgesGets the errors for an invalid user badge barcode.
FindInvalidBadges Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuid?YesThe Api key that authorizes the customer to complete the request. Either UserID or UserBadgeBarcode must be provided for authentication when calling the Api. Contact your eQuip admin.
UserBadgeBarcodequerystringYesThe User Badge Barcode that authorizes the user to complete the request. Either UserID or UserBadgeBarcode must be provided for authentication when calling the Api. Contact your eQuip admin.
PageSizequeryintNoThe Number of Invalid UserBadgeBarcode errors to return. 0 returns all entries.
PageNumberqueryintNoThe page number to start retrieving data. 0 returns first page entries.

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

HTTP + XML

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

POST /xml/reply/FindInvalidBadges HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: application/xml
Content-Length: length

<FindInvalidBadges xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <UserBadgeBarcode>String</UserBadgeBarcode>
  <UserID>00000000-0000-0000-0000-000000000000</UserID>
</FindInvalidBadges>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<APIErrorDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dto">
  <ApiName>String</ApiName>
  <Error>String</Error>
  <ErrorLoggedDate>0001-01-01T00:00:00</ErrorLoggedDate>
  <FieldName>String</FieldName>
  <FieldValue>String</FieldValue>
</APIErrorDto>