The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
territoryName: String,
regionName: String,
divisionName: String,
legacyUserType: String,
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}